home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1996 September / JCSM Shareware Collection (JCS Distribution) (September 1996).ISO / communic / commo65.zip / MACRO.DOC < prev    next >
Text File  |  1995-07-15  |  154KB  |  5,219 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.     {COMMO} (tm)
  7.  
  8.                    "A New Standard in Telecommunications" 
  9.  
  10.  
  11.         by Fred P. Brucker
  12.  
  13.  
  14.  
  15.  
  16.  
  17.             Part II
  18.               Macro Programming Guide
  19.  
  20.  
  21.             Release 6.5
  22.               July 15, 1995
  23.  
  24.  
  25.  
  26.  
  27.  
  28.        (C)Copyright 1989-1995  Fred P. Brucker  All Rights Reserved 
  29.  
  30.  
  31.  
  32.  
  33. The {COMMO} program and associated on-disk documentation are the property
  34. of Fred P. Brucker (the "author") and may not be sold without permission. 
  35. The Shareware version may be distributed, unaltered and as a unit, via
  36. Electronic Bulletin Board Systems.
  37.  
  38. SHAREWARE DISTRIBUTORS and clubs, please see the file VENDOR.DOC for
  39. distribution guidelines.
  40.  
  41.  
  42. THE AUTHOR OF THIS PROGRAM DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR
  43. IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
  44. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH REGARD TO THE
  45. SOFTWARE, THE ACCOMPANYING WRITTEN MATERIALS AND THE DISKETTES.  IN NO
  46. EVENT SHALL THE AUTHOR BE LIABLE TO YOU FOR ANY CONSEQUENTIAL, SPECIAL,
  47. INCIDENTAL OR INDIRECT DAMAGES OF ANY KIND ARISING OUT OF THE USE OF THE
  48. SOFTWARE, EVEN IF THE AUTHOR HAS BEEN SPECIFICALLY ADVISED OF THE
  49. POSSIBILITY OF SUCH DAMAGES.  IN NO EVENT WILL THE AUTHOR'S LIABILITY
  50. EXCEED THE ACTUAL PRICE PAID FOR THE LICENSE TO USE THE SOFTWARE.
  51.  
  52. YOUR USE OF THIS PROGRAM CONSTITUTES YOUR ACCEPTANCE OF THESE TERMS.
  53.  
  54.  
  55. {COMMO} is a trademark of Fred P. Brucker.  All other trademarks and
  56. registered trademarks referenced in this document are the property of their
  57. respective owners.
  58.  
  59.  
  60.  
  61.                      ================================
  62.                      {COMMO} Registration Information
  63.                      ================================
  64.  
  65.   {COMMO} is a "SHAREWARE" product.  You are entitled to evaluate it for
  66.   30 days.  If it suits your needs and you would like to continue using
  67.   it, then you must pay the licensing fee.  Please use the REGISTRATION
  68.   FORM on the next page.
  69.  
  70.   When you REGISTER you will be licensed to use all future SHAREWARE
  71.   releases of {COMMO}.  You will never have to pay an "update" charge.
  72.   Registration allows you to eliminate delay screens and to enable extra
  73.   features (see 65INFO.DOC for list).  Registered users will receive
  74.   priority support on Bulletin Boards and CompuServe (see 65INFO.DOC).
  75.  
  76.   Call or write for pricing information on MULTI-USER (SITE) and
  77.   DISTRIBUTION licenses.  Discounts are given on quantities of 10 or more.
  78.  
  79.   All prices shown are US DOLLARS.  Please remit US FUNDS on US BANK only.
  80.   NET 30 TERMS will be accepted on purchase orders totalling $100.00 or
  81.   more.
  82.  
  83.   The PRINTED MANUAL is 7 x 8.5 (inches) in size and includes an index.
  84.   The DISKETTE has the latest {COMMO} release plus the latest version of
  85.   the Enhanced MOSTHOST host macro.
  86.  
  87.   For orders, inquiries and support for registered users, call MON-SAT,
  88.   9am-5pm, EASTERN time.  If you get my answering machine, please try
  89.   again later (I cannot return long distance calls).
  90.  
  91.   To register by E-mail on CompuServe or Internet, upload the completed
  92.   Registration Form as a message (text or binary).
  93.  
  94.      MAILING ADDRESS:    Fred P. Brucker
  95.                          P.O. Box 141537
  96.                          Columbus, OH 43214
  97.  
  98.      VOICE TELEPHONE:    (614) 326-1309
  99.      COMPUSERVE:         71021,356
  100.      INTERNET:           71021.356@compuserve.com
  101.  
  102.   PAYMENT OPTIONS:
  103.  
  104.   1) CHECK or MONEY ORDER:  make payable to FRED P. BRUCKER.
  105.  
  106.   2) CREDIT CARD:  fill in the credit card information at the bottom of
  107.      the Registration Form (next page).  Credit card orders may be mailed,
  108.      phoned or E-mailed via CompuServe.
  109.  
  110. --------------------------------------------------------------------------
  111.  
  112.  
  113.  
  114.                  {COMMO} 6.5 SINGLE USER REGISTRATION FORM
  115.  
  116.   Name     _______________________________________________________________
  117.  
  118.   Company name (if company address)   ____________________________________
  119.  
  120.   Address  _______________________________________________________________
  121.  
  122.            _______________________________________________________________
  123.  
  124.            _______________________________________________________________
  125.  
  126.              * All prices include shipping and handling *            Number
  127.                                                                     of Copies
  128.   {COMMO} single user license with PRINTED MANUAL and DISKETTE:
  129.          Price in USA/Canada/Mexico ....................... $ 53.00   ____
  130.          OHIO residents (includes sales tax) ..............   56.05   ____
  131.          All other countries ..............................   60.00   ____
  132.  
  133.   {COMMO} single user license, with DISKETTE:
  134.          Price in USA/Canada/Mexico ....................... $ 40.00   ____
  135.          OHIO residents (includes sales tax) ..............   42.30   ____
  136.          All other countries ..............................   42.00   ____
  137.  
  138.   Special price for BBS sysops and students, with DISKETTE:
  139.          Price in USA/Canada/Mexico ....................... $ 30.00   ____
  140.          OHIO residents (includes sales tax) ..............   31.73   ____
  141.          All other countries ..............................   32.00   ____
  142.      Sysops: BBS name and phone number ____________________
  143.      Students: name of school _____________________________
  144.  
  145.   >>>>>>>>>>>>>>>>>>  Specify if OTHER than 3.5" HD diskette: _______
  146.  
  147.  
  148.                                       Enter total AMOUNT:   $ ____________
  149.  
  150.   Payment method:  Check__  Money order__  Visa__  MasterCard__
  151.                    Carte Blanche__  Diners Club__  JCB__   PO__
  152.  
  153.  
  154.      INFORMATION FOR CREDIT CARD PURCHASES ONLY:
  155.  
  156.      Card No. ________  ________  ________  ________  Expires ____/____
  157.                                                                mo.  yr.
  158.      Cardholder signature _____________________________________________
  159.  
  160.      Cardholder name __________________________________________________
  161.  
  162.      Daytime telephone  (_____) _____ _______
  163.  
  164. --------------------------------------------------------------------------
  165.  
  166.  
  167.  
  168.  
  169.   Answers to the following questions will help me serve you better in the
  170.   future:
  171.  
  172.   How did you obtain {COMMO}?  (If BBS, please give name and phone number)
  173.  
  174.   ________________________________________________________________________
  175.  
  176.   In general terms, what do you use {COMMO} for?
  177.  
  178.   ________________________________________________________________________
  179.  
  180.   ________________________________________________________________________
  181.  
  182.   What type of computer and modem do you use?
  183.  
  184.   ________________________________________________________________________
  185.  
  186.   ________________________________________________________________________
  187.  
  188.  
  189.   Comments / Questions ___________________________________________________
  190.  
  191.   ________________________________________________________________________
  192.  
  193.   ________________________________________________________________________
  194.  
  195.   ________________________________________________________________________
  196.  
  197.   ________________________________________________________________________
  198.  
  199.  
  200.   Thank you, and I hope you enjoy {COMMO}.
  201.  
  202.  
  203.  
  204.                                     -6-
  205.  
  206. ========
  207. Contents
  208. ========
  209.  
  210.  
  211. Programming {COMMO} Macros  . . . . . . . . . . . . . . . . . . . . . .   9
  212.      Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  213.      Macro Structure  . . . . . . . . . . . . . . . . . . . . . . . . .   9
  214.      Macro Functions  . . . . . . . . . . . . . . . . . . . . . . . . .  10
  215.      Macro Labels . . . . . . . . . . . . . . . . . . . . . . . . . . .  12
  216.      Macro Variables  . . . . . . . . . . . . . . . . . . . . . . . . .  13
  217.      How to Use Variables . . . . . . . . . . . . . . . . . . . . . . .  14
  218.      Reserved Variables . . . . . . . . . . . . . . . . . . . . . . . .  15
  219.      Executing Macros . . . . . . . . . . . . . . . . . . . . . . . . .  16
  220.      Additional Macro Execution Rules . . . . . . . . . . . . . . . . .  16
  221.      Cancelling a Macro . . . . . . . . . . . . . . . . . . . . . . . .  17
  222.      A Macro Example in Detail  . . . . . . . . . . . . . . . . . . . .  17
  223.  
  224. Description of Functions (Alphabetical) . . . . . . . . . . . . . . . .  20
  225.      ALARm  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  226.      ASCIiup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  227.      AUTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  22
  228.      BEEP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  229.      BREAk  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  23
  230.      CALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  24
  231.      CALOok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  25
  232.      CAPMode  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  233.      CAPTure  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  26
  234.      CHATmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  235.      CLEAr  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  236.      COMPare  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  27
  237.      CURSor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  28
  238.      DECRement  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  29
  239.      DIAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  29
  240.           Marking Numbers for Dialing . . . . . . . . . . . . . . . . .  31
  241.           Automatic Resumption of Dialing . . . . . . . . . . . . . . .  31
  242.           Testing Success and Failure Results . . . . . . . . . . . . .  31
  243.           Handling Incoming Calls . . . . . . . . . . . . . . . . . . .  32
  244.      DISPlay  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  32
  245.      DIVIde . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  33
  246.      DOORway  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  34
  247.      DPARms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  34
  248.      EDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  35
  249.      ELAPse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  36
  250.      EXECute  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  36
  251.           Using the Direct Switch: EXEC-D . . . . . . . . . . . . . . .  38
  252.           Using the Swap to Disk Switch: EXEC-S . . . . . . . . . . . .  38
  253.           EXECute Preview Mode  . . . . . . . . . . . . . . . . . . . .  39
  254.      EXIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  39
  255.      FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  40
  256.           Using FILE to get file information: FILE, FILE-X  . . . . . .  41
  257.           Using FILE to Select files: FILE-S  . . . . . . . . . . . . .  42
  258.      FONFile  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  42
  259.  
  260.  
  261.  
  262.                                     -7-
  263.  
  264.      GETString  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  43
  265.      GOLOok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  266.      GOTO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  45
  267.      HANGup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  46
  268.      HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
  269.      HOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
  270.      IFCArrier  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  47
  271.      IFCOndition  . . . . . . . . . . . . . . . . . . . . . . . . . . .  48
  272.      IFERrorlevel . . . . . . . . . . . . . . . . . . . . . . . . . . .  50
  273.      IFEXist  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  51
  274.      INCRement  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  52
  275.      INFOrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  52
  276.      INITmodem  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  53
  277.      INPUt  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  53
  278.      INSTring . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  54
  279.      KEYStuff . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  55
  280.      LENGth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  55
  281.      LIGHts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  55
  282.      LOCAlecho  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  56
  283.      LOOKfor  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  56
  284.      MACRo  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  58
  285.      MARK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  59
  286.      MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  60
  287.      MULTiply . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  62
  288.      NOCArrier  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  63
  289.      NOOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  63
  290.      OFFLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  63
  291.      PARMs  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  64
  292.      PASSword . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  65
  293.      PAUSe  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  65
  294.      POPStack . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  65
  295.      PRINtlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  66
  296.      PUSHstack  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  66
  297.      RCLOse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  67
  298.      READ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  67
  299.      RETUrn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  68
  300.      ROPEn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  69
  301.      RTRAn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  69
  302.      RXMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  70
  303.      RYMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
  304.      RZMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  72
  305.      SCREen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  74
  306.      SCROllback . . . . . . . . . . . . . . . . . . . . . . . . . . . .  74
  307.      SEND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  74
  308.      SETDial  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  75
  309.      SETEsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  76
  310.      SETGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  77
  311.      SETLook  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  78
  312.      SETR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
  313.      SETUp  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
  314.      SETVariable  . . . . . . . . . . . . . . . . . . . . . . . . . . .  80
  315.      SFICtrl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  82
  316.      SHELl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  82
  317.  
  318.  
  319.  
  320.                                     -8-
  321.  
  322.      SIGNal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  83
  323.      SOUNd  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  83
  324.      SPDCtrl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  84
  325.      SPOCtrl  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  84
  326.      SSLOok . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  85
  327.      STATusline . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
  328.      STOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
  329.      STRAn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  87
  330.      SUBString  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  88
  331.      SXMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  88
  332.      SYMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  89
  333.      SZMOdem  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  90
  334.           File Specifications . . . . . . . . . . . . . . . . . . . . .  91
  335.      TOGGles  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  91
  336.      UNLOad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  91
  337.      UNMArk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  92
  338.      VIDEo  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  93
  339.      VTCUr  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  93
  340.      VTPAd  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  93
  341.      WCLOse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  94
  342.      WINDow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  94
  343.      WOPEn  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  95
  344.      WRITe  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  95
  345.  
  346. For APPENDICES see Part I, COMMO.DOC. . . . . . . . . . . . . . . . . .  97
  347.  
  348.  
  349.  
  350.                                     -9-
  351.  
  352. ==========  Programming {COMMO} Macros
  353.  
  354. IMPORTANT!  Please read the next few pages before you attempt to write any
  355. macros!  The rules for writing {COMMO} macros are few in number, but must
  356. be followed carefully.
  357.  
  358. Examples of more complex macro programming are given in the sample Macro
  359. File COMMO.MAC, in the supplied file SAMPLES.MAC and in the Host Mode and
  360. Guide macros.  A macro from SAMPLES.MAC is discussed in detail at the end
  361. of this section.
  362.  
  363. The following pages assume familiarity with {COMMO}'s key commands and with
  364. other features of the program.  Since many macro functions have
  365. corresponding key commands, duplicate explanations will not be given here. 
  366. Refer to the description of the key command in Part I (COMMO.DOC).
  367.  
  368.  
  369. -----=====  Overview
  370.  
  371. {COMMO}'s Macro Files may contain any number of macros and are limited in
  372. size to 64k bytes each (total of 128k if auxiliary Macro File is used).
  373.  
  374. Macros are "interpreted," which implies the following:
  375.  
  376.      (1)  Macros are not processed in any way until execution begins. 
  377.           Rules for starting macros are listed under "Executing Macros"
  378.           later in this section.
  379.  
  380.      (2)  Only macros within the currently loaded Macro File(s) are
  381.           available for immediate use.
  382.  
  383.      (3)  Macros added or modified with the Internal Editor are ready for
  384.           execution without additional processing.
  385.  
  386. COMMO.MAC is the resident Macro File.  An auxiliary Macro File may be
  387. loaded (or replaced) at any time using the CALL and GOTO functions (or
  388. manually within the Macro File window).  See the individual descriptions of
  389. the CALL, GOTO and RETUrn functions for details.  See also Appendix K for
  390. more information on Macro Files.
  391.  
  392. Macro Files may be compiled to increase speed, to reduce size and to
  393. improve security of source code.  See "[Alt-M]  Macro File" in Part I
  394. (COMMO.DOC) for details.
  395.  
  396.  
  397. -----=====  Macro Structure
  398.  
  399. Macros consist of a series of items enclosed in curly braces.  Multiple
  400. items may be placed on the same line, but a single item may not be split
  401. between lines.  Lines may be up to 255 characters in length and all text
  402. outside the curly braces is commentary and is ignored when macros are
  403. executing.
  404.  
  405.  
  406.  
  407.                                     -10-
  408.  
  409. There are two types of items: "functions" and "labels."
  410.  
  411.      Functions are action items.  Some are equivalent to {COMMO} key
  412.      commands, such as DIAL, while others are unique to the macro language,
  413.      such as SETVariable.
  414.  
  415.      Labels are macro entry points and may be placed anywhere within the
  416.      Macro File.
  417.  
  418.  
  419. -----=====  Macro Functions
  420.  
  421. Each macro function is described in detail later in this document.  See
  422. also Appendix J "Macro Functions Listed by Class."
  423.  
  424.  
  425. The general form of any macro function is:
  426.  
  427.      {name-switches arg1,arg2,...,argn}
  428.  
  429.           name
  430.                The function name describes the action to be performed and
  431.                consists of four or more characters. Only the first four are
  432.                significant and case is ignored.
  433.  
  434.           switches
  435.                These are used to alter the operation of a function.  Each
  436.                switch is a single letter and may be followed by a numeric
  437.                value, usually "1" or "0" to indicate "yes" or "no"
  438.                respectively.
  439.  
  440.                Switches have default interpretations when the numeric value
  441.                is omitted, or when the switch is not present.
  442.  
  443.                Switches must be separated from the name with a hyphen (no
  444.                intervening spaces).  They may be upper or lower case.
  445.  
  446.                See individual function descriptions for details (note that
  447.                only certain functions have switches).
  448.  
  449.           args
  450.                A SINGLE SPACE separates the arguments from the function
  451.                name and switches.
  452.  
  453.                Individual arguments are separated with commas and may
  454.                contain no extraneous spaces (all spaces are significant).
  455.  
  456. NOTE:  Curly braces may be represented within macro functions by using ^(
  457. for { and ^) for }.
  458.  
  459.  
  460.  
  461.                                     -11-
  462.  
  463. Examples:
  464.  
  465.      {send Hi, how are you?}
  466.  
  467.           This function sends the string "Hi, how are you?" to the modem. 
  468.           SEND has only one argument -- the string to send out.  Since the
  469.           string is the last argument, it may contain commas and spaces. 
  470.           Quotes are not used to define strings.
  471.  
  472.      {ifcon-LE label1,label2}
  473.  
  474.           The IFCOndition function tests for conditions set by other
  475.           functions, such as COMPare.  Here two switches are present,
  476.           telling {COMMO} to test for less than or equal:
  477.  
  478.                L    Test for "less than."
  479.                E    Test for "equal."
  480.  
  481.           The two arguments are labels to GOTO depending on the conditions.
  482.  
  483.           Notice that "name-switches" may be written in a number of
  484.           different ways:
  485.  
  486.                ifco-LE  ifcondition-EL  ifcond-LE
  487.  
  488.      {asci-S0E1 path\filename}
  489.  
  490.           The ASCII Upload function will send the file indicated by
  491.           "path\filename."  The switches override current settings and tell
  492.           {COMMO}:
  493.  
  494.                S0   Do NOT strip linefeeds.
  495.                E1   DO expand blank lines (may also be written "E").
  496.  
  497.      {sound}   {sound yes}
  498.  
  499.           The first function will TOGGLE Master Sound ON/OFF (since there
  500.           is no argument).  The second will turn the sound ON.
  501.  
  502.  
  503. One very important function is the STOP function.  It is used to terminate
  504. macro execution and may appear in either its long form or short form:
  505.  
  506.      ... {stop}     long form
  507.      ... {}         short form
  508.  
  509. Macro execution continues until a STOP function is executed.  Be sure to
  510. use one or execution will continue into the next macro in the Macro File!
  511.  
  512.  
  513.  
  514.                                     -12-
  515.  
  516. -----=====  Macro Labels
  517.  
  518. Labels are identifiers consisting of one or more characters.  When a label
  519. is defined, it must be preceded by a colon.  References to labels, such as
  520. {goto label}, do not require the colon.
  521.  
  522. IMPORTANT!  {COMMO} always searches for labels from the beginning of the
  523. auxiliary Macro File (if one is loaded), then from the beginning of the
  524. resident Macro File.  This means that if a label is duplicated within the
  525. files, the first occurrence will be used.
  526.  
  527. Only the first eight characters in a label are significant.  Case is
  528. ignored.  All characters above ASCII 27 are allowed in labels except the
  529. following:
  530.  
  531.      colon           ":"
  532.      space           " "
  533.      comma           ","
  534.      slash           "/"
  535.      curly braces    "{" or "}"
  536.  
  537. Examples:
  538.  
  539.      {:mailrun} {call login} ...
  540.  
  541.      {:start-here} {:another.entry} {send Begin now!} ...
  542.  
  543.  
  544. A number of three character labels are reserved and are called "key-
  545. labels."  When the corresponding key is pressed from the Terminal Screen,
  546. {COMMO} will look for the key-label in the current Macro File.  If the key-
  547. label is found, macro execution will begin at that location.
  548.  
  549. Any default key assignment may be overridden using a key-label.  For
  550. example, pressing Alt-D normally enters the Dialing Directory.  But suppose
  551. this line is in the Macro File:
  552.  
  553.      {:ald} {clear} {}
  554.  
  555. Now pressing Alt-D will clear the screen.
  556.  
  557. There are predefined key-labels and user-defined key-labels.  See Appendix
  558. H "{COMMO} Macro Key-labels" for complete details.
  559.  
  560.  
  561.  
  562.                                     -13-
  563.  
  564. -----=====  Macro Variables
  565.  
  566. {COMMO} maintains a String Variable Space in which variables appear in the
  567. form:
  568.  
  569.      name,string
  570.  
  571.           name
  572.                An identifier consisting of one or more characters of which
  573.                only the first eight are significant.  Case is ignored.  The
  574.                following are the ONLY valid characters that may be used in
  575.                a variable name:
  576.  
  577.                     "A" through "Z"
  578.                     "a" through "z"
  579.                     "0" through "9"
  580.                     "_" underscore
  581.  
  582.                All other characters will terminate the name.
  583.  
  584.           string
  585.                A text string.  The string must not contain ASCII 0, 10 or
  586.                13 (null/cr/lf).  If a string is set to null (0 characters),
  587.                it is deleted from variable space.  Note the difference
  588.                between the null character (ASCII 0) and a null string (0
  589.                characters).
  590.  
  591.                NOTE:  Any variable not defined is considered to be null.
  592.  
  593.                Strings consisting of only the digits 0-9 and representing a
  594.                decimal number from 0 to 4,294,967,295 (2^32-1) are also
  595.                numeric variables.  There is no other difference between
  596.                string and numeric variables.
  597.  
  598.                The maximum length of strings is 240 characters.
  599.  
  600. The String Variable Space may be viewed from within the Macro File window
  601. (see Online Help).  The amount of unused string space will also be shown.
  602.  
  603. Once a variable is defined, it remains in String Variable Space until it is
  604. redefined or deleted (set to null).  Therefore variables should be deleted
  605. or re-used to prevent String Variable Space from becoming full.
  606.  
  607. The default size of String Variable Space is 3072 bytes, but it may be
  608. adjusted with the "/v" command line switch at program startup.  The valid
  609. range is from 512 bytes to 65535 bytes.  See also "Command Line Options" in
  610. Part I (COMMO.DOC).
  611.  
  612.  
  613.  
  614.                                     -14-
  615.  
  616. ----------  How to Use Variables
  617.  
  618. {COMMO} variables may be set (or "defined") in numerous ways:
  619.  
  620.      1)  With the SET item in the Setup File.
  621.      2)  By various macro functions.
  622.      3)  By variable strings at the end of a Dialing Directory entry.
  623.      4)  During execution of certain program operations.
  624.  
  625. Variables are used (or "referenced") in macro function arguments and in the
  626. telephone number field of the Dialing Directory.  See also "[Alt-D] 
  627. Dialing Directory" in Part I (COMMO.DOC).
  628.  
  629. When a variable name appears, the string assigned to the name is
  630. substituted for the name.  If the variable is null, then the name is
  631. replaced with 0 characters.  {COMMO} will expand the variables in a macro
  632. function before executing it.
  633.  
  634. In order to distinguish variable names from other parts of function
  635. arguments, they must be preceded with a percent sign "%" (use two
  636. consecutive percent signs if a percent sign is needed in the data).
  637.  
  638. The end of the variable name is indicated with another "%" or with the
  639. first character that is not allowed in a name (see list of characters
  640. above).
  641.  
  642.  
  643. A variable definition example:
  644.  
  645.      {setvar animal,Elephant} or {setvar %animal,Elephant}
  646.  
  647.           Notice that the "%" is not required (but is permitted) when the
  648.           variable name is the first argument of a function that defines,
  649.           modifies or tests the value of a variable.  Other such functions
  650.           include INPUt, GETString, INCRement, DECRement, COMPare,
  651.           SUBString, INSTring, READ.
  652.  
  653.           If the variable name itself needs to be a variable, then use two
  654.           percent signs:
  655.  
  656.                {setv %%animal,Elephant}
  657.  
  658.  
  659. Variable usage examples:
  660.  
  661.      {setvar animal,Elephant}
  662.      {send %animal}
  663.           Sends "Elephant" to the modem.
  664.      {send animal}
  665.           Sends "animal".
  666.      {send %animal%s are large animals}
  667.           Sends "Elephants are large animals".  Note that the trailing "%"
  668.           is required here.
  669.  
  670.  
  671.  
  672.                                     -15-
  673.  
  674.  
  675.      {setvar animal,Elephant}
  676.      {setv creature,animal}
  677.      {send creature}
  678.           Sends "creature". 
  679.      {send %creature}
  680.           Sends "animal". 
  681.      {setv %%creature,Giraffe}
  682.      {send %animal}
  683.           Sends "Giraffe".
  684.  
  685.  
  686. IMPORTANT!  Variables may NOT be substituted within the function name or
  687. switches.  They may be substituted anywhere else, even for the commas
  688. separating arguments.
  689.  
  690. See "SETVariable" for additional examples and more ways to set variables.
  691.  
  692.  
  693. ----------  Reserved Variables
  694.  
  695. Certain variables have fixed names so that {COMMO} can find them whenever
  696. they are needed.  The names of these variables begin with an underscore
  697. character "_".  There are two types of reserved variables: "user-defined"
  698. and "built-in" (see Appendix I "List of Reserved Variables" for a complete
  699. list).
  700.  
  701. USER-DEFINED reserved variables are defined in the same way that you define
  702. ordinary variables -- in the Setup File using SET, or in a macro using
  703. functions such as SETVariable, INPUt, etc.  These variables define strings
  704. used by certain program features.  For example, the path\filename of the
  705. Usage Log is defined in the Setup File as follows:
  706.  
  707.      {set _uselog,c:\commo\commo.log}
  708.  
  709. BUILT-IN variables are defined by {COMMO} based on current system 
  710. parameters.  Examples are:
  711.  
  712.      _cap
  713.           Current Capture File path\filename
  714.  
  715.      _tim
  716.           Current time of day
  717.  
  718. Any variable that starts with the same four characters as a built-in
  719. variable ("_" plus the next three) will be considered the same variable. 
  720. For example "_pas" may be written "_password" and "_yea" may be written
  721. "_year".
  722.  
  723. {COMMO} will always search String Variable Space first when looking up the
  724. value of any variable.  This allows built-in variables to be overridden,
  725. but only when using their four character minimum names.  For example, to
  726. override the serial port number, you must use "_por", not "_port".
  727.  
  728.  
  729.  
  730.                                     -16-
  731.  
  732.  
  733. See Appendix I for a complete list of reserved variables.
  734.  
  735.  
  736. -----=====  Executing Macros
  737.  
  738. Macro execution may be started in any of the following ways:
  739.  
  740. 1)   Open the Macro File window by pressing Alt-M.  Position the Selector
  741.      Bar at the desired starting point and press [Enter].  The macro will
  742.      begin executing at the first macro label or function on the line.
  743.  
  744.      NOTE:  Macros started with the Selector Bar do not need macro labels
  745.      and may be started at any point within the macro.
  746.  
  747. 2)   If a macro label is also a key-label, then you may press that key from
  748.      the Terminal Screen.  Note that if the same key-label appears more
  749.      than once, the first occurrence will be used.
  750.  
  751. 3)   A macro may be linked to a Dialing Directory entry (Linked Macro).  In
  752.      this case {COMMO} will GOTO the macro when a connection is established
  753.      with that system (or optionally CALL it, see the DIAL function).
  754.  
  755. 4)   A startup macro may be specified in the Setup File using the
  756.      "{mac=label}" item.
  757.  
  758. 5)   A startup macro may be specified on the command line with the switch
  759.      "/:label".  This will override the Setup File macro.
  760.  
  761. 6)   A macro may be an argument of another function such as CALL, GOTO,
  762.      DIAL or SETLook.
  763.  
  764. Some macro functions show their current action on the Status Line.  In
  765. addition, a "face" character in the middle of the Status Line indicates
  766. that a macro is executing.
  767.  
  768.  
  769. -----=====  Additional Macro Execution Rules
  770.  
  771. Characters may be typed to the serial port during functions that wait
  772. (LOOKfor, GETString, PAUSe, HOLD, etc.).  Command keys will be ignored
  773. during macro execution.
  774.  
  775. Functions will execute IN SEQUENCE until one of the following conditions
  776. occurs:
  777.  
  778. 1)   A CALL, GOTO, RETURn, STOP, EXIT, etc. is encountered.
  779.  
  780. 2)   Control is transferred to an alternate macro from certain functions
  781.      when a special condition occurs.  An example of this is the SETLook
  782.      function.  The alternate will execute when a subsequent LOOKfor times
  783.      out.
  784.  
  785.  
  786.  
  787.                                     -17-
  788.  
  789. 3)   A Macro Error occurs (and SETR has not been executed).  This will
  790.      bring up the Macro File window with the Selector Bar on the problem
  791.      line.  The macro will be terminated.
  792.  
  793. 4)   The end of a Macro File is reached.
  794.  
  795.  
  796. -----=====  Cancelling a Macro
  797.  
  798. The [Esc] key is used to terminate macro execution.  To type an <esc> code
  799. (ASCII 27) to the remote during macro execution (without terminating the
  800. macro), press Ctrl-[ (Ctrl + left bracket).
  801.  
  802. Current function execution may be terminated by pressing [Ctrl-Break].  For
  803. example, this can be used to terminate a LOOKfor, PAUSe or HOLD
  804. prematurely.  Macro execution will advance to the next function.
  805.  
  806. If a macro contains a function that brings up a {COMMO} window (Dialing
  807. Directory, Capture File Options, etc.), then [Esc] will exit the window and
  808. execution continues with the next function.  To terminate macro execution
  809. from a window, press [Ctrl-Break].
  810.  
  811. NOTE:  The SETEsc function may be used to help prevent accidental
  812. termination of macros.
  813.  
  814.  
  815. -----=====  A Macro Example in Detail
  816.  
  817. The following macro example from SAMPLES.MAC can be used to log in to many
  818. types of Bulletin Board Systems.  This is a Linked Macro, so the label
  819. "login" would appear in the Dialing Directory macro field for each system
  820. that uses it.  When you dial and connect to one of the systems, {COMMO}
  821. will automatically GOTO the macro.
  822.  
  823. The subroutine "gls" (generic login subroutine) can also be called from
  824. macros that perform mailruns and other BBS operations.
  825.  
  826. Note that labels and functions may be placed side by side on the same line
  827. (up to 255 characters).  For purposes of this example each item is placed
  828. on its own line.
  829.  
  830. The main routine at "login" performs some initial functions and then calls
  831. the subroutine at "gls".  The subroutine looks for various prompts,
  832. responds to them and returns after responding to the "password" prompt.
  833.  
  834.  
  835. {:login}
  836.      The entry point.  All labels begin with a ":".
  837.  
  838. {capture y,c:\commo\commo.cap}
  839.      "y" means open the Capture File.  The path\filename of the file is
  840.      specified here, otherwise the current Capture File (if there is one)
  841.      would be opened.
  842.  
  843.  
  844.  
  845.                                     -18-
  846.  
  847.  
  848. {asci ,}
  849.      Set ASCII Upload to "no pacing."
  850.  
  851. {call gls}
  852.      CALL the macro at "gls".  When the subroutine executes a RETUrn,
  853.      control will come back here.
  854.  
  855. {}
  856.      STOP and resume manual operation in the Terminal Screen.  Without this
  857.      STOP execution would continue into subsequent macros.  Remember that
  858.      labels are "passed over" during sequential macro execution.
  859.  
  860. {:gls}
  861.      The entry point of the "gls" subroutine.
  862.  
  863. {setlook 60,hng,10,|}
  864.      This function specifies parameters that go into effect whenever a
  865.      LOOKfor executes.  It tells {COMMO} to wait up to 60 seconds for the
  866.      string (or strings) and to GOTO the label "hng" if none of the strings
  867.      appear within that time.  The timer is restarted each time a LOOKfor
  868.      begins to execute.
  869.  
  870.      This SETLook also specifies that a "|" (carriage return) should be
  871.      sent to the modem whenever 10 seconds have elapsed and no characters
  872.      are received.  This is used to respond to prompts that are not
  873.      explicitly specified in SSLOoks/CALOoks/GOLOoks/LOOKfors (e.g., "Press
  874.      any key to continue").
  875.  
  876.      Use this latter facility with care since a BBS may spend time
  877.      processing and not actually be expecting input from the caller.  The
  878.      carriage returns sent will accumulate and be used to satisfy later
  879.      prompts, causing things to get out of "sync."  Adjust the 10 second
  880.      timeout as needed.
  881.  
  882. {setv ss_r,~|}
  883. {setv ss_yr,~y|}
  884.      Variables are set for some common responses.  They will be used later
  885.      by SSLOok functions.  For convenience, these variables may be defined
  886.      in the Setup File (using the "set" keyword).
  887.  
  888.      SSLOoks, CALOoks and GOLOoks store strings to look for, but do not
  889.      wait for the strings (only a LOOKfor can do the actual waiting).
  890.  
  891. {:li1}
  892. {sslo ss_r,(enter)}
  893. {sslo ss_yr,graphics (enter)}
  894. {sslo ss_yr,is this correct} 
  895.      The SSLOoks will send the strings in the variables when the respective
  896.      targets are received.  The looking for all of the stored strings then
  897.      resumes.
  898.  
  899. {calo li1,li2,first name}
  900.  
  901.  
  902.  
  903.                                     -19-
  904.  
  905. {calo li1,li3,last name}
  906.      CALOoks will CALL the second label if the target string appears (the
  907.      LOOKfor is terminated).  When the macro executes a RETUrn, control
  908.      goes to the first label where all of the strings can be set up again. 
  909.      Note that CALOoks are used here for demonstration.  SSLOoks could be
  910.      used as well (and probably should be).
  911.  
  912. {golo li1,;passwor}
  913.      A GOLOok will set up a string and GOTO the label if the string appears
  914.      (only one label is used).  In this example the specified string is to
  915.      be ignored.  This was needed for a BBS that used the string
  916.      "first;last;password" prior to the actual password prompt.
  917.  
  918. {lookfor password}
  919.      This is where the actual "looking" takes place.  Remember that
  920.      SSLOoks, CALOoks and GOLOoks only cause strings to be stored but do
  921.      not actually wait for the strings.
  922.  
  923.      The LOOKfor will wait for the string specified and also any other
  924.      stored strings (up to 16 total).  If the string in the LOOKfor
  925.      appears, control passes to the next macro function.
  926.  
  927.      "password" is assumed to be the last prompt in the login sequence.
  928.  
  929. {send ~%_pas|}
  930.      Control then passes here and the string is sent to the modem.  The
  931.      tilde (~) causes a half-second delay before sending the password.  The
  932.      password in the Dialing Directory entry was stored into the built-in
  933.      variable "_pas" when dialing began.
  934.  
  935.      Finally, a carriage return (|) is sent.
  936.  
  937. {return}
  938.      This will RETUrn to the "login" macro.
  939.  
  940. {:li2}
  941. {send ~Firstname|}
  942.      Response to "first name".
  943.  
  944. {return}
  945.  
  946. {:li3}
  947. {send ~Lastname|}
  948.      Response to "last name".
  949.  
  950. {return}
  951.  
  952.  
  953.  
  954.                                     -20-
  955.  
  956. ==========  Description of Functions (Alphabetical)
  957.  
  958. The purpose of this section is to show the syntax of each function and the
  959. meaning of its arguments through examples.  All functions are listed here,
  960. but details for functions which are also default key commands are found in
  961. Part I (COMMO.DOC) under "{COMMO} Key Commands."
  962.  
  963. Function names are shown with their four-letter abbreviations in uppercase.
  964.  
  965. For consistency, the following conventions are used in many functions:
  966.  
  967.      "y" or "yes" is used to indicate "yes", "on",  "open",  etc.
  968.      "n" or "no"  is used to indicate "no",  "off", "close", etc.
  969.  
  970.  
  971. ===  ALARm  ===
  972.  
  973. Default key:   none
  974. Description:   Ring the alarm.
  975.  
  976. Switches:
  977.  
  978.      F1 or F
  979.           Make the "failed" sound.
  980.  
  981.      F0
  982.           Make the "success" (ringing) sound (default).
  983.  
  984. Examples:
  985.  
  986.      {alarm}
  987.           Ring alarm, use ring count in Setup File.
  988.  
  989.      {alarm 2}
  990.           Ring alarm 2 times.
  991.  
  992. {COMMO} will wait until the alarm has stopped ringing before proceeding to
  993. the next macro function (the alarm may be terminated early by pressing a
  994. key).
  995.  
  996.  
  997. ===  ASCIiup  ===
  998.  
  999. Default key:   Alt-A
  1000. Description:   Upload an ASCII (text) file.
  1001.  
  1002. General form:
  1003.  
  1004.      {ASCIiup path\filename[\],pace}
  1005.  
  1006.           path\filename
  1007.                The complete path and filename (if the path is absent, the
  1008.                current directory will be used).
  1009.  
  1010.  
  1011.  
  1012.                                     -21-
  1013.  
  1014.  
  1015.                If a path only is used (signified by a "\" at the end) the
  1016.                ASCII Upload window will open, prompting you to enter the
  1017.                filename.
  1018.  
  1019.           pace
  1020.                The pacing character to be used.
  1021.  
  1022. Switches:
  1023.  
  1024.      E1 or E
  1025.           Expand blank lines.  A space will be sent when a zero-character
  1026.           line is encountered.
  1027.  
  1028.      E0
  1029.           Do not expand blank lines.
  1030.  
  1031.      S1 or S
  1032.           Strip linefeeds from outgoing text.
  1033.  
  1034.      S0
  1035.           Do not strip linefeeds.
  1036.  
  1037.           If a switch is absent, the current setting of the toggle will be
  1038.           used.  The toggles are initialized in the Setup File and may be
  1039.           changed for the session from the Alt-T menu.
  1040.  
  1041.           Switches apply to the current function only and do not affect the
  1042.           settings of the toggles.
  1043.  
  1044. Examples:    
  1045.  
  1046.      {asci}
  1047.           Open ASCII Upload window.
  1048.  
  1049.      {asci-S}
  1050.           Open ASCII Upload window, strip linefeeds when file is sent.
  1051.  
  1052.      {asci %uldir%\}
  1053.           Open ASCII Upload window, prompt with the current value of the
  1054.           variable "uldir".
  1055.  
  1056.      {asci c:\msgs\file.xyz,:}
  1057.           Upload "file.xyz."  Use ":" for pacing.
  1058.  
  1059.  
  1060.  
  1061.                                     -22-
  1062.  
  1063.      {asci-E0 c:\msgs\file.xyz}
  1064.           Upload "file.xyz."  Use current pacing character, do not expand
  1065.           blank lines.
  1066.  
  1067.      {asci c:\msgs\file.xyz,}
  1068.           Upload "file.xyz."  Do not use pacing.
  1069.  
  1070.      {asci ,?}
  1071.           Set current pacing character to "?"
  1072.  
  1073.      {asci ,}
  1074.           Set current pacing to "no" pacing.
  1075.  
  1076. The pacing character may be entered according to the rules shown in
  1077. Appendix D.  For example, "^m" or "|" may be used to represent the carriage
  1078. return.
  1079.  
  1080.  
  1081. ===  AUTO  ===
  1082.  
  1083. Default key:   none
  1084. Description:   Maintain Auto Receive strings.
  1085.  
  1086. General form:
  1087.  
  1088.      {AUTO label,string}
  1089.  
  1090.           label
  1091.                Label to GOTO when the string is received.
  1092.  
  1093.           string
  1094.                String to look for, may be up to 32 characters.
  1095.  
  1096. Examples:
  1097.  
  1098.      {auto}
  1099.           Clear all Auto Receive strings.
  1100.  
  1101.      {auto zmodem,^XB00}
  1102.           Zmodem Auto Receive string.
  1103.  
  1104. Note that up to 16 Auto Receive strings may be in effect at the same time
  1105. (including any strings defined with the "aut" item in the Setup File).
  1106.  
  1107. Use this function with no arguments to clear all strings when necessary
  1108. (you cannot clear an individual string).
  1109.  
  1110. See also "TIPS on creating LOOKfor strings" under LOOKfor.
  1111.  
  1112.  
  1113.  
  1114.                                     -23-
  1115.  
  1116. ===  BEEP  ===
  1117.  
  1118. Default key:   none
  1119. Description:   Play a sequence of sounds.
  1120.  
  1121. Examples:
  1122.  
  1123.      {beep 36,440,18,523}
  1124.           Play an A note for two seconds followed by a C note for one
  1125.           second.
  1126.  
  1127.      {beep}
  1128.           Default is a short beep sound.
  1129.  
  1130. Listed arguments are treated as pairs.  The first number of each pair is
  1131. the duration of the sound in 18ths of a second (system clock ticks).  The
  1132. second number is the frequency in Hz (0 to 19 is silence).
  1133.  
  1134. Here is a frequency chart for five octaves:
  1135.  
  1136.      C         131     262     523     1040     2093
  1137.      C#/Db     139     277     554     1103     2217
  1138.      D         147     294     587     1176     2349
  1139.      D#/Eb     156     311     622     1241     2489
  1140.      E         165     330     659     1311     2637
  1141.      F         175     349     698     1391     2794
  1142.      F#/Gb     185     370     740     1488     2960
  1143.      G         196     392     784     1568     3136
  1144.      G#/Ab     208     415     831     1662     3322
  1145.      A         220     440     880     1760     3520
  1146.      A#/Bb     233     466     932     1866     3729
  1147.      B         248     494     988     1973     3951
  1148.  
  1149.  
  1150. ===  BREAk  ===
  1151.  
  1152. Default key:   Alt-B
  1153. Description:   Send a break.
  1154.  
  1155. Switches:
  1156.  
  1157.           Tn
  1158.                Set break duration in system clock ticks.  "n" may range
  1159.                from 1 to 999.  There are 18.2 clock ticks per second.
  1160.  
  1161.           T0 or T
  1162.                Set break duration to 18 clock ticks (default).
  1163.  
  1164.  
  1165.  
  1166.                                     -24-
  1167.  
  1168. Examples:
  1169.  
  1170.      {break}
  1171.           One second break.
  1172.  
  1173.      {break-t9}
  1174.           One-half second break.
  1175.  
  1176.      {break-t55}
  1177.           Three second break.
  1178.  
  1179.  
  1180. ===  CALL  ===
  1181.  
  1182. Default key:   none
  1183. Description:   Execute a macro subroutine.
  1184.  
  1185. General form:
  1186.  
  1187.      {CALL label,filename}
  1188.  
  1189.           label
  1190.                The label that begins the subroutine to be executed.
  1191.  
  1192.           filename
  1193.                The name of the Macro File where the label is to be found. 
  1194.                This argument is OPTIONAL and is normally used only if the
  1195.                file is not already loaded.  Do NOT specify a path; the
  1196.                {COMMO} home directory will be used.
  1197.  
  1198. Switches:
  1199.  
  1200.           F1 or F
  1201.                Force loading of the specified file (as the auxiliary file). 
  1202.                No filename comparison will be made.
  1203.  
  1204.           F0
  1205.                Compare filenames.  If the file is already loaded (resident
  1206.                or auxiliary), it will not be reloaded (default).
  1207.  
  1208. Examples:
  1209.  
  1210.      {call abc}
  1211.           Execute subroutine "abc".
  1212.  
  1213.      {call abc,other.mac}
  1214.           Execute subroutine "abc" in the auxiliary Macro File "other.mac".
  1215.  
  1216. CALL will push the return location onto the macro stack; then it will
  1217. transfer control to the given label.  When a RETUrn is executed, the
  1218. location will be popped and control will return to the function following
  1219. the CALL.  If the CALL is located in the auxiliary Macro File, the filename
  1220. will be saved on the macro stack along with the return location.
  1221.  
  1222.  
  1223.  
  1224.                                     -25-
  1225.  
  1226.  
  1227. If a filename is specified, {COMMO} will check to see if the file is
  1228. already loaded (resident or auxiliary).  If not, the file will be loaded as
  1229. the auxiliary (the current auxiliary will be saved to disk if there are any
  1230. outstanding changes).
  1231.  
  1232. TIPS on using CALL:
  1233.  
  1234.  *   It isn't necessary to specify a filename if the target label is in the
  1235.      resident Macro File or in the current auxiliary file.
  1236.  
  1237.  *   A Macro Error will result if either the label or the file do not
  1238.      exist.
  1239.  
  1240.  *   CALLs may be nested up to 32 deep.
  1241.  
  1242.  *   Use GOTO when you want to load or execute macros in another file and
  1243.      you do not need to return.  This will prevent the macro stack from
  1244.      filling with "dead" entries.
  1245.  
  1246.  *   Do not modify a Macro File while a CALL from that file is active (the
  1247.      return location may be invalidated).
  1248.  
  1249. See also RETUrn, GOTO, PUSHstack, POPStack, UNLOad, Appendix K.
  1250.  
  1251.  
  1252. ===  CALOok  ===
  1253.  
  1254. Default key:   none
  1255. Description:   CALL a label when a string appears.
  1256.  
  1257. General form:
  1258.  
  1259.      {CALOok label1,label2,target}
  1260.  
  1261.           label1
  1262.                The location to return to after label2 is CALLed.
  1263.  
  1264.           label2
  1265.                The label to CALL when the target is received from the
  1266.                serial port.
  1267.  
  1268.           target
  1269.                The ASCII string to look for.  The string begins following
  1270.                the "," and is terminated by the "}".
  1271.  
  1272. CALOok is used in conjunction with the LOOKfor function.  It sets up an
  1273. additional string to look for.  When the target string appears, a CALL is
  1274. made to "label2."  When the routine executes a RETUrn, control will pass to
  1275. "label1".  This is equivalent to:
  1276.  
  1277.      {call label2} {:label1} ...
  1278.  
  1279.  
  1280.  
  1281.                                     -26-
  1282.  
  1283. See LOOKfor for details, examples and tips on using CALOok.
  1284.  
  1285. See also SSLOok, GOLOok, SETLook.
  1286.  
  1287.  
  1288. ===  CAPMode  ===
  1289.  
  1290. Default key:   none
  1291. Description:   Set Capture Mode.
  1292.  
  1293. Examples:
  1294.  
  1295.      {capmode screen}
  1296.           Set Capture Mode to SCREEN.
  1297.  
  1298.      {capmode filter}
  1299.           Set Capture Mode to FILTER.
  1300.  
  1301.      {capmode raw}
  1302.           Set Capture Mode to RAW.
  1303.  
  1304. See also CAPTure.
  1305.  
  1306.  
  1307. ===  CAPTure  ===
  1308.  
  1309. Default key:   Alt-1
  1310. Description:   Capture File Options.
  1311.  
  1312. Switches:
  1313.  
  1314.      N1 or N
  1315.           Do not wait for a keypress if the disk fills up while capturing
  1316.           (a message is displayed for several seconds).  The setting
  1317.           remains in effect until the Capture File is closed.
  1318.  
  1319.           NOTE:  This switch is effective only on a CAPTure function that
  1320.           successfully opens a Capture File.
  1321.  
  1322.      N0
  1323.           Wait for Esc to be pressed if the disk fills up (default).
  1324.  
  1325. Examples:
  1326.  
  1327.      {capture}
  1328.           Open Capture File Options window.
  1329.  
  1330.      {capture y}
  1331.           Open current Capture File.
  1332.  
  1333.  
  1334.  
  1335.                                     -27-
  1336.  
  1337.      {capture n}
  1338.           Close current Capture File.
  1339.  
  1340.      {capt y,c:\commo\file.xyz}
  1341.           Open indicated Capture File.
  1342.  
  1343.      {capt n,c:\dl\newfile.cap}
  1344.           Close current Capture File, set new file as indicated.
  1345.  
  1346. The current Capture File will always be closed when a new file is opened.
  1347.  
  1348. IMPORTANT!  If the disk fills while capture is open, a "disk full" message
  1349. will appear (see the "N" switch above) and the file will be closed.  The
  1350. built-in variable "_dfc" will be set to 1.
  1351.  
  1352. See also CAPMode.
  1353.  
  1354.  
  1355. ===  CHATmode  ===
  1356.  
  1357. Default key:   Alt-- (Alt minus)
  1358. Description:   Set Chat Mode toggle.
  1359.  
  1360. Examples:
  1361.  
  1362.      {chat}
  1363.           Toggle Chat Mode on/off.
  1364.  
  1365.      {chat y}
  1366.           Turn on Chat Mode.
  1367.  
  1368.      {chat n}
  1369.           Turn off Chat Mode
  1370.  
  1371.  
  1372. ===  CLEAr  ===
  1373.  
  1374. Default key:   Alt-C
  1375. Description:   Clear Terminal Screen to default colors.
  1376.  
  1377. Example:
  1378.  
  1379.      {clear}
  1380.           No arguments.
  1381.  
  1382.  
  1383. ===  COMPare  ===
  1384.  
  1385. Default key:   none
  1386. Description:   Compare a string or numeric variable.
  1387.  
  1388.  
  1389.  
  1390.                                     -28-
  1391.  
  1392. General form:
  1393.  
  1394.      {COMPare name,string}
  1395.  
  1396.           name
  1397.                The name of a variable.
  1398.  
  1399.           string
  1400.                A string of ASCII characters.
  1401.  
  1402. Examples:
  1403.  
  1404.      {comp pword,aardvark}
  1405.           Test if the variable "pword" is set to "aardvark."
  1406.  
  1407.      {comp pword}
  1408.           Test if "pword" is null.
  1409.  
  1410.      {comp pword,}
  1411.           Test if "pword" is null.
  1412.  
  1413.      {comp nmbr,5}
  1414.           Compare a numeric variable.
  1415.  
  1416.      {comp abc,%xyz}
  1417.           Test if the variable "abc" is equal to the variable "xyz."
  1418.  
  1419. A numeric variable is a string of ASCII digits, 0-9, forming a positive
  1420. integer.  If the number is outside the allowed range or contains non-
  1421. numeric characters, the results of the compare will be unpredictable.
  1422.  
  1423. COMPare will set flags which can be tested with the IFCOndition function.
  1424.  
  1425.      The Condition Flag will be set to "true" if the two arguments are
  1426.      identical strings (case is ignored).  Otherwise it will be set to
  1427.      "false."
  1428.  
  1429.      The Numeric Flag will be set to "equal", "less than" or "greater
  1430.      than."  This flag is unpredictable unless both arguments are valid
  1431.      numeric variables.
  1432.  
  1433. A variable may be tested for being null (no entry in variable space) by
  1434. omitting the second argument (or by comparing to a null variable).
  1435.  
  1436. See also IFCOndition.
  1437.  
  1438.  
  1439. ===  CURSor  ===
  1440.  
  1441. Default key:   none
  1442. Description:   Terminal Screen cursor on/off.
  1443.  
  1444.  
  1445.  
  1446.                                     -29-
  1447.  
  1448. Examples:
  1449.  
  1450.      {cursor}
  1451.           Toggle Terminal cursor on/off.
  1452.  
  1453.      {curs y}
  1454.           Turn on Terminal Screen cursor.
  1455.  
  1456.      {curs n}
  1457.           Turn off Terminal Screen cursor.
  1458.  
  1459.  
  1460. ===  DECRement  ===
  1461.  
  1462. Default key:   none
  1463. Description:   Subtract a number from a numeric variable.
  1464.  
  1465. Examples:
  1466.  
  1467.      {decr count}
  1468.           Subtract 1 from the variable "count".
  1469.  
  1470.      {decr apples,200}
  1471.           Subtract 200 from "apples".
  1472.  
  1473. The default for the second argument is 1.
  1474.  
  1475. If the result is less than 0 or if either argument is out of range, then
  1476. the variable will be set to the string "ERROR".
  1477.  
  1478. If the variable is not numeric, the results will be unpredictable.
  1479.  
  1480. See also INCRement.
  1481.  
  1482.  
  1483. ===  DIAL  ===
  1484.  
  1485. Default keys:  Alt-D, Alt-N
  1486. Description:   Open Dialing Directory, dial marked systems.
  1487.  
  1488. General form:
  1489.  
  1490.      {DIAL tries,label1,label2}
  1491.  
  1492.           tries
  1493.                The maximum number of dialing tries.  If no connection is
  1494.                established when the try count is exhausted, the macro in
  1495.                the second argument will be started.  May be 0 to 999.  "0"
  1496.                means unlimited.  Default is 0.
  1497.  
  1498.  
  1499.  
  1500.                                     -30-
  1501.  
  1502.           label1
  1503.                A macro to GOTO if the try count in the first argument is
  1504.                exhausted.  If no macro is specified or if the macro label
  1505.                is invalid, control will pass to the next function.  Default
  1506.                is none.
  1507.  
  1508.                If the "C" switch is used, the macro will be CALLed.  When a
  1509.                RETUrn is executed, control will return to the DIAL
  1510.                function.
  1511.  
  1512.           label2
  1513.                A macro to GOTO when a response is matched during the Inter-
  1514.                dial Delay.  Response strings may be listed in the reserved
  1515.                variable "_dialir" and are usually defined in the Setup
  1516.                File.  If no macro is specified or if the macro label is
  1517.                invalid, the response is ignored.
  1518.  
  1519.                If the "C" switch is used, the macro will be CALLed.  When a
  1520.                RETUrn is executed, control will return to the DIAL
  1521.                function.
  1522.  
  1523. Switches:
  1524.  
  1525.      C1 or C
  1526.           Specifies that macros will be started via CALL (instead of GOTO). 
  1527.           When the macros execute a RETUrn, control returns to the DIAL
  1528.           function and Multi Number Dialing will resume.
  1529.  
  1530.           The "C" switch applies to the Linked Macro (from the Dialing
  1531.           Directory), the "tries exhausted" macro and to the Inter-dial
  1532.           Delay macro.
  1533.  
  1534.      C0
  1535.           Start dialing macros via GOTO (default).
  1536.  
  1537. Examples:
  1538.  
  1539.      {dial}
  1540.           Open Dialing Directory window (similar to Alt-D).
  1541.  
  1542.      {dial ,}
  1543.           Multi Number Dial (similar to Alt-N).
  1544.  
  1545.      {dial 25,abc}
  1546.           Multi Number Dial with try count.
  1547.  
  1548.      {dial-C ,}
  1549.           Multi Number Dial, CALL Linked Macros.
  1550.  
  1551.      {dial-c ,,inter}
  1552.           Multi Number Dial with Inter-dial Delay macro.
  1553.  
  1554.  
  1555.  
  1556.                                     -31-
  1557.  
  1558. ----------  Marking Numbers for Dialing
  1559.  
  1560. Numbers may be marked in one of several ways:
  1561.  
  1562.      1)   Manually in the Dialing Directory window.
  1563.      2)   By placing Dialing Strings on the {COMMO} command line.
  1564.      3)   Using the MARK macro function.
  1565.  
  1566. Marked numbers will be redialed in sequence.  If a connection occurs and a
  1567. valid Linked Macro is specified in the Dialing Directory, the macro will be
  1568. started via GOTO (or CALL if the "C" switch is present).  If no Linked
  1569. Macro is specified in the Dialing Directory or if the macro label is
  1570. invalid, macro execution will STOP.
  1571.  
  1572. If no numbers are marked when executing the DIAL, control will pass to the
  1573. next function.
  1574.  
  1575.  
  1576. ----------  Automatic Resumption of Dialing
  1577.  
  1578. Here are two methods for resuming at the end of a Linked Macro.  Both allow
  1579. multiple systems to be called without operator intervention.
  1580.  
  1581.      1)   Use the "C" switch on the DIAL function.  Each Linked Macro
  1582.           should end with a RETUrn which will transfer control back to the
  1583.           DIAL.  When all numbers have been called, control will pass to
  1584.           the function following the DIAL.
  1585.  
  1586.      2)   At the end of each Linked Macro (after logging off), GOTO a macro
  1587.           such as this:
  1588.  
  1589.             {:nocar} {pause 1} {ifcarrier nocar} {dial ,} {}
  1590.  
  1591.           This ensures that carrier has dropped before DIALing the next
  1592.           number.  The PAUSe allows data to display on the screen while
  1593.           waiting for carrier to drop.
  1594.  
  1595.  
  1596. ----------  Testing Success and Failure Results
  1597.  
  1598. Details about a successful or failed dialing attempt are available in
  1599. several reserved variables (see Appendix I "List of Reserved Variables" for
  1600. complete descriptions):
  1601.  
  1602.      _dtc
  1603.           Dialing termination code
  1604.  
  1605.      _dialrt
  1606.           Dialing response text
  1607.  
  1608.      _mod
  1609.           Speed reported by modem (normally in the CONNECT or CARRIER
  1610.           response)
  1611.  
  1612.  
  1613.  
  1614.                                     -32-
  1615.  
  1616.  
  1617. After a successful attempt the variables "_dialrt" and "_mod" may be tested
  1618. in your Linked Macro.  For example, if you expected a high-speed connect
  1619. and the speed reported was 2400 or 1200, then you may want to hang up and
  1620. try again later.
  1621.  
  1622. You can get control after each failed attempt by using "DIAL 1", with or
  1623. without a macro.  For example:
  1624.  
  1625.      1)   {dial-c 1,nocon} ...
  1626.  
  1627.           The Linked Macro and the "no connect" macro will be CALLed (the
  1628.           "C" switch).  The variables "_dtc" and "_dialrt" may be tested in
  1629.           the macro at "nocon".
  1630.  
  1631.      2)   {dial 1} ...
  1632.  
  1633.           Control will pass to the next function if a dialing attempt fails
  1634.           or when no more systems are marked (test "_dtc" to determine
  1635.           which).
  1636.  
  1637. If the testing indicates that the system should not be dialed again (e.g.,
  1638. it did not answer, _dtc = 3), the UNMArk function can be used with the "L"
  1639. switch to unmark the last number dialed: {unmark-l}.
  1640.  
  1641.  
  1642. ----------  Handling Incoming Calls
  1643.  
  1644. Most modems return the string "RING" when a call comes in.  If this happens
  1645. during the Inter-dial Delay, you may choose to stop dialing (to answer a
  1646. voice call) or to send a brief message to a modem caller (during a BBS
  1647. event, for example).
  1648.  
  1649. Use "label2" on the DIAL function to process responses during the Inter-
  1650. dial Delay.  For example:
  1651.  
  1652.      {dial ,,incoming}
  1653.  
  1654. The macro at "incoming" will execute if the modem sends an Inter-dial Delay
  1655. response string (these are normally defined in the Setup File with the
  1656. "_dialir" variable).
  1657.  
  1658. See also SETDial, MARK, UNMArk.
  1659.  
  1660.  
  1661. ===  DISPlay  ===
  1662.  
  1663. Default key:   none
  1664. Description:   Display a string to the screen.
  1665.  
  1666. General form:
  1667.  
  1668.      {DISPlay row,col,attr,string}
  1669.  
  1670.  
  1671.  
  1672.                                     -33-
  1673.  
  1674.  
  1675.           row
  1676.                The row where the string will display.
  1677.  
  1678.           col
  1679.                The column where the string will display.
  1680.  
  1681.           attr
  1682.                The attribute (colors) of the string.
  1683.  
  1684.           string
  1685.                The text of the string (no quotes).
  1686.  
  1687. Examples:
  1688.  
  1689.      {display 12,20,17,Hello!}
  1690.           Display "Hello!" at row 12, column 20.  Colors are white on blue.
  1691.  
  1692.      {disp ,,,Hello, again.^m^j}
  1693.           Display "Hello, again." at the current cursor using the current
  1694.           attribute, followed by a cr/lf.
  1695.  
  1696.      {disp 3,40}
  1697.           Position the cursor at row 3, column 40.
  1698.  
  1699. TIPS on using DISPlay:
  1700.  
  1701.  *   The attribute is specified in the same manner as the colors in the
  1702.      Setup File (press F7 in the Internal Editor to display the Color
  1703.      Chart).
  1704.  
  1705.  *   Setting background colors to high intensity values will cause blinking
  1706.      (for example, using "9" instead of "1" will still give a blue
  1707.      background but the foreground character will blink).  
  1708.  
  1709.  *   After the string is displayed, the previous Terminal Screen attribute
  1710.      will be restored.
  1711.  
  1712.  *   Conversion is performed on the string according to the rules in
  1713.      Appendix D.
  1714.  
  1715.  
  1716. ===  DIVIde  ===
  1717.  
  1718. Default key:   none
  1719. Description:   Divide a numeric variable by a number.
  1720.  
  1721. Example:
  1722.  
  1723.      {divi space,1024}
  1724.           Divide "space" by 1024.
  1725.  
  1726. The divisor (second argument) is limited to 65535 (default is 1).
  1727.  
  1728.  
  1729.  
  1730.                                     -34-
  1731.  
  1732.  
  1733. The named variable will be set to the quotient, the built-in variable
  1734. "_rem" will be set to the remainder.
  1735.  
  1736. If the divisor is zero or if either argument is out of range, then the
  1737. variable will be set to the string "ERROR".
  1738.  
  1739. If the variable is not numeric, the results will be unpredictable.
  1740.  
  1741.  
  1742. ===  DOORway  ===
  1743.  
  1744. Default key:   Alt-=
  1745. Description:   Toggle Doorway Mode.
  1746.  
  1747. Switches:
  1748.  
  1749.      S1 or S
  1750.           Status Line on when entering Doorway Mode.
  1751.  
  1752.      S0
  1753.           Status Line off (default).
  1754.  
  1755.      M0
  1756.           Do not display Doorway enter/exit messages.
  1757.  
  1758.      M1
  1759.           Display enter/exit messages (default).
  1760.  
  1761. Examples:
  1762.  
  1763.      {doorway}
  1764.           Toggle Doorway Mode on/off.
  1765.  
  1766.      {door-S}
  1767.           Status Line on when entering Doorway Mode.
  1768.  
  1769.      {doorway-M0}
  1770.           Do not display enter/exit messages.
  1771.  
  1772. The "S" switch is ignored when exiting Doorway Mode (the Status Line will
  1773. be restored to its prior state).
  1774.  
  1775.  
  1776. ===  DPARms  ===
  1777.  
  1778. Default key:   Alt-P
  1779. Description:   Set Default Dialing Terminal Parameters
  1780.  
  1781. General form:
  1782.  
  1783.      {DPARms speed,format,comport,terminal-type,delay}
  1784.  
  1785.  
  1786.  
  1787.                                     -35-
  1788.  
  1789.           speed
  1790.                The bps rate: 2400, 38400, etc.
  1791.  
  1792.           format
  1793.                The data format: 8n1, 7e1, etc.
  1794.  
  1795.           comport
  1796.                The serial port number: 1, 2, 3 or 4.
  1797.  
  1798.           terminal
  1799.                The terminal-type: A, V or T.
  1800.  
  1801.           delay
  1802.                The inter-character delay factor: 0-999.
  1803.  
  1804. Examples:
  1805.  
  1806.      {dparms 38400,8,1,,20}
  1807.           Set 38400 bps, 8n1, Com1, delay=20.
  1808.  
  1809.      {dparms ,,4,V}
  1810.           Set Com4 VT102.
  1811.  
  1812.      {dparms 19200,7o1}
  1813.           Set 19200 bps, 7o1.
  1814.  
  1815. IMPORTANT!  Omitted parameters are not changed.
  1816.  
  1817. These are the parameters that are set whenever a number is DIALed.  Any of
  1818. them may be overridden in the Dialing Directory entry.
  1819.  
  1820. See also PARMs.
  1821.  
  1822.  
  1823. ===  EDIT  ===
  1824.  
  1825. Default key:   none
  1826. Description:   Edit an external file.
  1827.  
  1828. Example:
  1829.  
  1830.      {edit c:\autoexec.bat}
  1831.           Edit AUTOEXEC.BAT file.
  1832.  
  1833. EDIT may be used to edit any text file up to 64k in length.  The rules are
  1834. the same as for editing a support file with the Internal Editor.  See
  1835. Appendix K for more information.
  1836.  
  1837. TIPS on using EDIT:
  1838.  
  1839.  *   Any data beyond the last cr/lf pair will be removed prior to editing. 
  1840.      There must be at least one valid line in the file or an error will
  1841.      result.
  1842.  
  1843.  
  1844.  
  1845.                                     -36-
  1846.  
  1847.  
  1848.  *   The file will be saved unconditionally when Alt-F is pressed or
  1849.      conditionally (if changes were made) when Esc is pressed.  The file is
  1850.      "saved in place" (no backup).
  1851.  
  1852.  
  1853. ===  ELAPse  ===
  1854.  
  1855. Default key:   none
  1856. Description:   Reset the elapsed timer to 0 minutes.
  1857.  
  1858. Example:
  1859.  
  1860.      {elap}
  1861.           No arguments.
  1862.  
  1863. NOTE:  The elapsed timer is automatically reset whenever dialing begins and
  1864. when a connection is made with a remote system.
  1865.  
  1866.  
  1867. ===  EXECute  ===
  1868.  
  1869. Default key:   none
  1870. Description:   Execute a DOS command.
  1871.  
  1872. Switches:
  1873.  
  1874.      A1 or A
  1875.           Sound the alarm at the end of command execution.
  1876.  
  1877.      A0
  1878.           Do not sound the alarm (default).
  1879.  
  1880.      D1 or D
  1881.           Execute an external program directly, without use of the command
  1882.           processor (see details below).
  1883.  
  1884.      D0
  1885.           Use the command processor (default).
  1886.  
  1887.      N1 or N
  1888.           Do NOT clear the screen before execution.  This is useful when
  1889.           running programs that clear or rewrite the screen.  Also for
  1890.           simple DOS functions like changing directories, renaming files,
  1891.           etc.  
  1892.  
  1893.      N0
  1894.           Clear the screen (default).
  1895.  
  1896.  
  1897.  
  1898.                                     -37-
  1899.  
  1900.      S1 or S
  1901.           Swap to Disk before executing the program (see details below).
  1902.  
  1903.      S0
  1904.           Do not swap to disk (default).
  1905.  
  1906.      W
  1907.           Wait for a key press before restoring the Terminal Screen.  This
  1908.           is useful if you need to see the results of the command
  1909.           execution.
  1910.  
  1911.      Wn
  1912.           Wait for "n" seconds, "n" may range from 0 to 999.  Press a key
  1913.           to cancel the wait.
  1914.  
  1915.           Note:  Default (no "W" switch) is no wait.
  1916.  
  1917. Examples:
  1918.  
  1919.      {exec-AW3 hslink -P%_por %pr_file -U%pr_down}
  1920.           {COMMO} will prepare the HS/Link command by expanding the "%"
  1921.           variables, then call DOS to execute the program.
  1922.  
  1923.           See the section "Macro Variables" for complete details on
  1924.           variable substitution.
  1925.  
  1926.           The alarm will sound at completion (the "A" switch) and {COMMO}
  1927.           will wait for three seconds (the "W3" switch) before restoring
  1928.           the Terminal Screen.
  1929.  
  1930.      {execute-DN c:\utils\list.com %_cap}
  1931.           The LIST program will be directly executed with the current
  1932.           Capture File path\filename as a command line argument.  The
  1933.           screen will not be cleared (LIST will rewrite the screen). 
  1934.           {COMMO} will return immediately to the Terminal Screen when LIST
  1935.           exits.
  1936.  
  1937. The EXECute function enables you to "build" a command to be executed by
  1938. DOS.  The DOS command processor (COMMAND.COM) is normally used (see below),
  1939. which implies that you may specify any command as you would type it from
  1940. the DOS prompt.
  1941.  
  1942. Thus you can execute batch files and internal DOS commands (REN, DEL,
  1943. etc.).  Also you can omit command paths and extensions (if the command is
  1944. in your PATH or in the current directory).
  1945.  
  1946. Character conversion is performed in the EXECute function.  This enables
  1947. you to specify control characters.  For example:
  1948.  
  1949.      {exec echo ^L> prn}   Send a formfeed to the printer
  1950.  
  1951. See Appendix D for details on conversion.  Note that the vertical bar "|"
  1952. is NOT translated to a carriage return in the EXECute function.  
  1953.  
  1954.  
  1955.  
  1956.                                     -38-
  1957.  
  1958.  
  1959. Key codes may be placed in the keyboard buffer prior to EXECute using the
  1960. KEYStuff function.
  1961.  
  1962.  
  1963. ----------  Using the Direct Switch: EXEC-D
  1964.  
  1965. Use this switch to execute .EXE and .COM programs without the use of the
  1966. command processor (usually COMMAND.COM).
  1967.  
  1968. The program's Exit Code (called ERRORLEVEL in batch files) is saved and may
  1969. be tested with the IFERrorlevel function.  The Exit Code is also available
  1970. in the variable "_err".
  1971.  
  1972. There are several advantages to using the "D" switch:
  1973.  
  1974. 1)   Only the memory needed to run the program is required (the command
  1975.      processor requires that about 32k be available, even if the program
  1976.      being run is much smaller).
  1977.  
  1978. 2)   About 4k of memory is saved by not having a copy of the command
  1979.      processor resident when the program is running.
  1980.  
  1981. 3)   The program executes faster, since COMMAND.COM is not loaded from
  1982.      disk.
  1983.  
  1984. 4)   The program's Exit Code is preserved and may be tested with the
  1985.      {COMMO} IFERrorlevel function.
  1986.  
  1987. Two important rules must be followed when using the "D" switch:
  1988.  
  1989. 1)   The full path\filename of the program file must be specified,
  1990.      including the path where the file resides on disk and the file
  1991.      extension.  For example:
  1992.  
  1993.           {exec-D c:\util\list.com file.txt}
  1994.  
  1995. 2)   Only .EXE and .COM files may be run (batch files and internal DOS
  1996.      commands cannot be executed without COMMAND.COM).
  1997.  
  1998.  
  1999. ----------  Using the Swap to Disk Switch: EXEC-S
  2000.  
  2001. Using the "S" switch will free up most of the memory used by {COMMO}.  The
  2002. program and data will be saved to a special disk file.  The path\filename
  2003. of this file is specified with "swp=" in the Setup File (under "Paths and
  2004. Files").  If the Swap File cannot be created or there is not enough disk
  2005. space for the swap, the EXECute (or SHELl) will be attempted without
  2006. swapping.
  2007.  
  2008. When the program or shell exits back to {COMMO}, everything will be
  2009. restored in memory.  Any errors in this process will cause {COMMO} to exit
  2010. to DOS.
  2011.  
  2012.  
  2013.  
  2014.                                     -39-
  2015.  
  2016.  
  2017. TIPS on using Swap to Disk:
  2018.  
  2019.  *   Use Swap to Disk when running major applications such as external
  2020.      protocol programs, offline mail readers, etc.  Using it with internal
  2021.      DOS functions (DEL, COPY, REN, etc.) or very small programs is
  2022.      inefficient and unnecessary.
  2023.  
  2024.  *   If possible, specify the Swap File on a RAMDISK.  This will speed up
  2025.      the swap considerably.  A ramdisk program is supplied with DOS
  2026.      (RAMDRIVE.SYS or VDISK.SYS) or you can obtain one from a BBS.
  2027.  
  2028.  *   Be sure to specify a complete path\filename for the Swap File.
  2029.  
  2030.  *   Do not run any TSR (resident) programs when swapping is in effect. 
  2031.      Doing so may result in a swap error.
  2032.  
  2033.  *   The Dialing Directory, resident Macro File and auxiliary Macro File
  2034.      are saved under their original filenames if they have changed.  Thus
  2035.      they may be utilized and/or modified while in the swap/shell.
  2036.  
  2037.  
  2038. ----------  EXECute Preview Mode
  2039.  
  2040. Use the Set Toggles key command, Alt-T, to turn on "EXECute Preview Mode." 
  2041. This mode is used to test your DOS commands and performs the following
  2042. steps for each EXECute function:
  2043.  
  2044. 1)   The command will be displayed after expanding variables and converting
  2045.      control characters.
  2046.  
  2047. 2)   You will be given an opportunity to edit and/or cancel the command
  2048.      before it is executed.
  2049.  
  2050. 3)   Following execution {COMMO} will wait before restoring the Terminal
  2051.      Screen.  This lets you see any error messages that the command may
  2052.      have displayed.
  2053.  
  2054.  
  2055. ===  EXIT  ===
  2056.  
  2057. Default key:   Alt-X
  2058. Description:   Exit {COMMO}.
  2059.  
  2060. General form:
  2061.  
  2062.      {EXIT number}
  2063.  
  2064.           number
  2065.                The return code to be passed to DOS.  It may be tested with
  2066.                the IF ERRORLEVEL batch command.  Range is 0 to 255.
  2067.  
  2068.  
  2069.  
  2070.                                     -40-
  2071.  
  2072. Switches:
  2073.  
  2074.      D1 or D
  2075.           Drop DTR and RTS.  Dropping DTR will cause the modem to
  2076.           disconnect if it has been properly initialized.  See Appendix A.
  2077.  
  2078.      D0
  2079.           Do not drop DTR and RTS.
  2080.  
  2081.           If the switch is absent, the current setting of the toggle will
  2082.           be used.  The toggle can be set in the Setup File or by using the
  2083.           Alt-T key command.
  2084.  
  2085. Examples:
  2086.  
  2087.      {exit}
  2088.           No arguments (return code = 0).
  2089.  
  2090.      {exit 3}
  2091.           With return code.
  2092.  
  2093.      {exit-D}
  2094.           Drop DTR and RTS.
  2095.  
  2096.  
  2097. ===  FILE  ===
  2098.  
  2099. Default key:   none
  2100. Description:   Find or display directory information.
  2101.  
  2102. General form:
  2103.  
  2104.      {FILE path\filespec}
  2105.  
  2106.           path\filespec
  2107.                The path and filespec (file mask) to be used for finding or
  2108.                displaying directory entries (filenames and subdirectories). 
  2109.                The filespec may contain wildcards.
  2110.  
  2111. Switches:
  2112.  
  2113.      X1 or X
  2114.           Find next matching entry.
  2115.  
  2116.      X0
  2117.           Find first matching entry (default).
  2118.  
  2119.      S1 or S
  2120.           Display a listing of filenames and subdirectories.
  2121.  
  2122.  
  2123.  
  2124.                                     -41-
  2125.  
  2126. Examples:
  2127.  
  2128.      {file c:\upload\*.*}
  2129.           Find first filename or subdirectory in the directory "c:\upload."
  2130.  
  2131.      {file-x}
  2132.           Find next filename or subdirectory.
  2133.  
  2134.      {file-s c:\upload\*.zip}
  2135.           Display all subdirectories and .ZIP files in the directory
  2136.           "c:\upload".
  2137.  
  2138.  
  2139. ----------  Using FILE to get file information: FILE, FILE-X
  2140.  
  2141. The FILE function will find directory information about the files and
  2142. subdirectories specified in "filespec."  The data will be made available in
  2143. the following built-in variables:
  2144.  
  2145.      _ffn
  2146.           Filename or subdirectory name.  Subdirectory names will be
  2147.           preceded with a "\".  The parent directory is "\..".
  2148.  
  2149.      _ffs
  2150.           File size in bytes.
  2151.  
  2152.      _ffd
  2153.           File date.  The format will be as specified in Setup File item
  2154.           "dat=".
  2155.  
  2156.      _fft
  2157.           File time.  The format will be as specified in Setup File item
  2158.           "tim=".
  2159.  
  2160. The FILE function must be executed without the "X" switch (or with X0) to
  2161. initialize the directory.  This will also make available the first filename
  2162. or subdirectory.  Subsequent executions (with the "X" switch) will make
  2163. subsequent names available.
  2164.  
  2165. Use the IFCOndition function to determine if a filename was made available. 
  2166. The first label ("true") will be taken if a filename was found;  the second
  2167. label ("false") will be taken if no additional filenames are available.
  2168.  
  2169. TIPS on using FILE, FILE-X:
  2170.  
  2171.  *   IMPORTANT!  Do not use IFEXist until all files have been found (it
  2172.      uses the same DOS file finding functions).
  2173.  
  2174.  *   The built-in variables will always contain the data for the last
  2175.      filename found.  If no filename has ever been found, the contents are
  2176.      unpredictable.
  2177.  
  2178.  
  2179.  
  2180.                                     -42-
  2181.  
  2182. ----------  Using FILE to Select files: FILE-S
  2183.  
  2184. The "S" switch is used when you want {COMMO} to display the names of the
  2185. files in the specified directory.  Files may then be selected (tagged) for
  2186. uploading or other purposes.  Tagged pathnames are appended to the file
  2187. {SEND}.LST in the {COMMO} home directory (except when Esc is pressed). 
  2188. Facilities are also provided for navigating, changing the filespec and
  2189. editing the {SEND}.LST file.
  2190.  
  2191. The Exit Code is set according to the user's action (keys are shown in
  2192. Online Help) and the built-in variable "_ffn" contains returned information
  2193. (when applicable).  The Exit Code appears in the variable "_err" and may
  2194. also be tested with the IFERrorlevel function.  Exit Codes are as follows:
  2195.  
  2196.      0    The "finish" key has been pressed.
  2197.  
  2198.      1    The Escape key has been pressed.
  2199.  
  2200.      2    The "edit" key has been pressed.
  2201.  
  2202.      3    A new drive has been chosen (drive letter is in "_ffn").
  2203.  
  2204.      4    A new directory has been chosen (subdirectory name is in "_ffn"
  2205.           and is preceded by a "\";  the parent directory is "\..").
  2206.  
  2207.      5    A new file specification has been entered (filespec is in "_ffn",
  2208.           e.g., *.zip).
  2209.  
  2210. TIPS on using FILE-S:
  2211.  
  2212.  *   Use {wind-k} to get a smooth display between invocations of FILE-S.
  2213.  
  2214.  *   When a clean list is desired, {SEND}.LST should be deleted prior to
  2215.      the first use of FILE-S.
  2216.  
  2217.  
  2218. ===  FONFile  ===
  2219.  
  2220. Default key:   none
  2221. Description:   Load a new Dialing Directory file.
  2222.  
  2223. Example:
  2224.  
  2225.      {fonf local.fon}
  2226.           The Dialing Directory is replaced with the file LOCAL.FON.
  2227.  
  2228. (Note that this feature is unavailable during shareware evaluation.)
  2229.  
  2230. The current Dialing Directory file will be saved to disk if there are any
  2231. outstanding changes.  Dialing marks in the new file will be erased if
  2232. {cdm=yes} in the Setup File.
  2233.  
  2234.  
  2235.  
  2236.                                     -43-
  2237.  
  2238. ===  GETString  ===
  2239.  
  2240. Default key:   none
  2241. Description:   Input a string from the modem to a variable.
  2242.  
  2243. General form:
  2244.  
  2245.      {GETString name,count,label}
  2246.  
  2247.           name
  2248.                The name of the variable to which the string will be
  2249.                assigned.
  2250.  
  2251.           count
  2252.                The maximum number of data characters allowed.  A carriage
  2253.                return will always terminate input.  May be 1 to 240. 
  2254.                Default is 240.
  2255.  
  2256.           label
  2257.                A macro to GOTO if a carriage return is received and no
  2258.                characters have been entered (the string will be assigned as
  2259.                null).  If this argument is omitted, control will pass to
  2260.                the next function.
  2261.  
  2262. Switches:
  2263.  
  2264.      A1 or A
  2265.           "Append" mode.  Characters will be appended to the variable.  If
  2266.           the current length of the variable is greater than the count in
  2267.           the second argument, a count of 240 will be assumed.
  2268.  
  2269.      A0
  2270.           The variable will be replaced (default).
  2271.  
  2272.      H1 or H
  2273.           "Hotkey" mode.  When the maximum number of characters has been
  2274.           entered, control will pass to the next function.
  2275.  
  2276.      H0
  2277.           Ignore all input after the maximum has been entered, except
  2278.           backspace and carriage return (default).
  2279.  
  2280.      I1 or I
  2281.           "Input" mode.  In this mode, characters from the modem will be
  2282.           ignored during the GETString (they will be buffered) and
  2283.           characters typed locally will not be sent to the remote.  This is
  2284.           another way to get local input (see also INPUt and INFOrm).  Echo
  2285.           Status from SETGet is ignored.
  2286.  
  2287.      I0
  2288.           Normal mode (default).
  2289.  
  2290.  
  2291.  
  2292.                                     -44-
  2293.  
  2294.      P1 or P
  2295.           "Password" mode.  Asterisks will be echoed to the remote and
  2296.           local terminals in place of the received characters (Echo Status
  2297.           will be honored, see SETGet).
  2298.  
  2299.      P0
  2300.           Characters are echoed as received (default).
  2301.  
  2302.      R1 or R
  2303.           "Raw" mode.  A single character will be received and converted to
  2304.           a decimal number string.  All 256 character values are allowed. 
  2305.  
  2306.      R0
  2307.           Normal GETString rules apply (default).
  2308.  
  2309. Examples:
  2310.  
  2311.      {setget 60,timeout,y,^m^j}
  2312.           Set GETString parameters.
  2313.  
  2314.      {gets fonum,12,badinput}
  2315.           Get input to "fonum."
  2316.  
  2317.      {gets-p pword,20}
  2318.           Get a password.
  2319.  
  2320.      {gets-r char}
  2321.           Get an ASCII character value (0-255).
  2322.  
  2323. TIPS on using GETString:
  2324.  
  2325.  *   Use SETGet to set important parameters for GETString.
  2326.  
  2327.  *   A carriage return (ASCII 13) terminates input.  The backspace
  2328.      character (ASCII 8) is used for simple editing.  ASCII 0 and 10 are
  2329.      ignored.  All other characters will be accepted.  Note that tab (ASCII
  2330.      9) will cause problems in host macros.  Use RTRAn to filter tabs if
  2331.      necessary.
  2332.  
  2333.  *   GETString supports "tandem" input.  Characters entered at either end
  2334.      will be input to the string (and displayed at both ends if echo is on
  2335.      (see SETGet).  Turn on Local Echo to see text locally that is sent to
  2336.      the remote with SEND, ASCIiup, etc.
  2337.  
  2338.  *   Use the "H" switch and a character count of 1 for "hotkeys."
  2339.  
  2340.  *   Turn off echo (see SETGet) while waiting for the modem to answer (in
  2341.      host mode).  Some modems react poorly to characters being echoed when
  2342.      they are generating a response (such as "RING").
  2343.  
  2344.  *   Incoming characters displayed during a GETString function are not seen
  2345.      by subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  2346.  
  2347.  
  2348.  
  2349.                                     -45-
  2350.  
  2351. See also SETGet, INPUt, INFOrm.
  2352.  
  2353.  
  2354. ===  GOLOok  ===
  2355.  
  2356. Default key:   none
  2357. Description:   GOTO a label when a string appears.
  2358.  
  2359. General form:
  2360.  
  2361.      {GOLOok label,target}
  2362.  
  2363.           label
  2364.                A label to GOTO when the target is received from the serial
  2365.                port.
  2366.  
  2367.           target
  2368.                The ASCII string to look for.  The string begins following
  2369.                the "," and is terminated by the "}".
  2370.  
  2371. GOLOok is used in conjunction with the LOOKfor function.  It sets up an
  2372. additional string to look for.  When the target string appears, control
  2373. will pass to the label.
  2374.  
  2375. See LOOKfor for details, examples and tips on using GOLOok.
  2376.  
  2377. See also SSLOok, CALOok, SETLook.
  2378.  
  2379.  
  2380. ===  GOTO  ===
  2381.  
  2382. Default key:   none
  2383. Description:   Transfer control of macro execution.
  2384.  
  2385. General form:
  2386.  
  2387.      {GOTO label,filename}
  2388.  
  2389.           label
  2390.                The label to which control will be transferred.
  2391.  
  2392.           filename
  2393.                The name of the Macro File where the label is to be found. 
  2394.                This argument is OPTIONAL and is normally used only if the
  2395.                file is not already loaded.  Do NOT specify a path; the
  2396.                {COMMO} home directory will be used.
  2397.  
  2398.  
  2399.  
  2400.                                     -46-
  2401.  
  2402. Switches:
  2403.  
  2404.           F1 or F
  2405.                Force loading of the specified file (as the auxiliary file). 
  2406.                No filename comparison will be made.
  2407.  
  2408.           F0
  2409.                Compare filenames.  If the file is already loaded (resident
  2410.                or auxiliary), it will not be reloaded (default).
  2411.  
  2412. Examples:
  2413.  
  2414.      {goto mail_run}
  2415.           Control transferred to label "mail_run".
  2416.  
  2417.      {goto mail_run,ginger.mac}
  2418.           Control transferred to label "mail_run" in the auxiliary Macro
  2419.           File "ginger.mac".
  2420.  
  2421.      {goto ,ginger.mac}
  2422.           The auxiliary Macro File "ginger.mac" is loaded; macro execution
  2423.           STOPs (no label given).
  2424.  
  2425. If a filename is specified, {COMMO} will check to see if the file is
  2426. already loaded (resident or auxiliary).  If not, the file will be loaded as
  2427. the auxiliary (the current auxiliary will be saved to disk if there are any
  2428. outstanding changes).
  2429.  
  2430. TIPS on using GOTO:
  2431.  
  2432.  *   It isn't necessary to specify a filename if the target label is in the
  2433.      resident Macro File or in the current auxiliary file.
  2434.  
  2435.  *   A Macro Error will result if either the label or the file do not
  2436.      exist.
  2437.  
  2438. See also CALL, UNLOad, Appendix K.
  2439.  
  2440.  
  2441. ===  HANGup  ===
  2442.  
  2443. Default key:   Alt-H
  2444. Description:   Disconnect by dropping DTR.
  2445.  
  2446. Examples:
  2447.  
  2448.      {hangup}
  2449.           Prompt user for disconnect.
  2450.  
  2451.      {hangup y}
  2452.           Disconnect without prompting.
  2453.  
  2454.  
  2455.  
  2456.                                     -47-
  2457.  
  2458. ===  HELP  ===
  2459.  
  2460. Default key:   F1
  2461. Description:   Open Online Help window.
  2462.  
  2463. Examples:
  2464.  
  2465.      {help}
  2466.           Display key command help
  2467.  
  2468.      {help x}
  2469.           Display topic "TX"
  2470.  
  2471. Any single character may be specified.  {COMMO} will prefix it with a "T"
  2472. and search for the topic code.  You may create your own Online Help file. 
  2473. See "Modifying the Help File" in Part I (COMMO.DOC).
  2474.  
  2475.  
  2476. ===  HOLD  ===
  2477.  
  2478. Default key:   none
  2479. Description:   Hold until specified time of day (24 hour format).
  2480.  
  2481. Examples:
  2482.  
  2483.      {hold 3:30}
  2484.           Hold until 3:30 am.
  2485.  
  2486.      {hold 16:10}
  2487.           Hold until 4:10 pm.
  2488.  
  2489.      {hold 0:00}
  2490.           Hold until midnight.
  2491.  
  2492. NOTE:  Incoming characters displayed during a HOLD function are not seen by
  2493. subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  2494.  
  2495.  
  2496. ===  IFCArrier  ===
  2497.  
  2498. Default key:   none
  2499. Description:   Test for presence of carrier detect signal.
  2500.  
  2501. General form:
  2502.  
  2503.      {IFCArrier true,false}
  2504.  
  2505.           true
  2506.                A label to GOTO or CALL if carrier is detected.
  2507.  
  2508.           false
  2509.                A label to GOTO or CALL if carrier is not detected.
  2510.  
  2511.  
  2512.  
  2513.                                     -48-
  2514.  
  2515. NOTE:  If a target label is omitted (null), control will pass to the next
  2516. function.
  2517.  
  2518. Switches:
  2519.  
  2520.      C1 or C
  2521.           A CALL is performed on the label.  When the CALLed routine
  2522.           RETUrns, execution will continue following the IFCArrier.
  2523.  
  2524.      C0
  2525.           A GOTO is performed (default).
  2526.  
  2527. Examples:
  2528.  
  2529.      {ifcarrier c10,c20}
  2530.           Using GOTO
  2531.  
  2532.      {ifcarrier-c c10,c20}
  2533.           Using CALL
  2534.  
  2535. TIP on using IFCArrier:
  2536.  
  2537.  *   When using a loop to wait for a change in carrier detect, you should
  2538.      include a short pause in the loop if you want characters to display. 
  2539.      The following sequence will display incoming characters while waiting
  2540.      for carrier detect to drop:
  2541.  
  2542.           ... {:cd1} {pause 1} {ifcarrier cd1} ...
  2543.  
  2544. See also NOCArrier.
  2545.  
  2546.  
  2547. ===  IFCOndition  ===
  2548.  
  2549. Default key:   none
  2550. Description:   Test for conditions set by other functions.
  2551.  
  2552. General form:
  2553.  
  2554.      {IFCOndition true,false}
  2555.  
  2556.           true
  2557.                A label to GOTO or CALL if the Condition Flag is true.
  2558.  
  2559.           false
  2560.                A label to GOTO or CALL if the Condition Flag is false.
  2561.  
  2562. NOTE:  If a target label is omitted (null), control will pass to the next
  2563. function.
  2564.  
  2565.  
  2566.  
  2567.                                     -49-
  2568.  
  2569. Numeric switches:
  2570.  
  2571.      no switches present
  2572.           Test the current state of the Condition Flag.
  2573.  
  2574.      E1 or E
  2575.           Test for numeric equality.  A numeric string contains only the
  2576.           digits 0-9 and is in the range 0 to 65535.
  2577.  
  2578.      L1 or L
  2579.           Numeric test -- if first COMPare argument is less than the
  2580.           second.
  2581.  
  2582.      G1 or G
  2583.           Numeric test -- if first COMPare argument is greater than the
  2584.           second.
  2585.  
  2586. Other switches:
  2587.  
  2588.      C1 or C
  2589.           A CALL is performed on the label.  When the CALLed routine
  2590.           RETUrns, execution will continue following the IFCOndition.
  2591.  
  2592.      C0
  2593.           A GOTO is performed (default).
  2594.  
  2595. Examples:
  2596.  
  2597.      {compare var1,message}
  2598.      {ifcondit match,nomatch}
  2599.           Compare and set Condition Flag.  GOTO "match" if the variable
  2600.           "var1" is set to "message," to "nomatch" if it is not.
  2601.  
  2602.      {compare value,200}
  2603.      {ifcon-GEC toobig,aok}
  2604.           Compare and set conditions.  CALL "toobig" if "value" is greater
  2605.           than or equal to 200, else CALL "aok."
  2606.  
  2607.      {instring zipcode,90}
  2608.      {ifcon yes,no}
  2609.           Test if "zipcode" contains the digits "90".  If "true" GOTO
  2610.           "yes", if "false" GOTO "no".
  2611.  
  2612. Switches may be used in any combination.  If any numeric switches are
  2613. present, the Condition Flag is not tested.
  2614.  
  2615. The difference between testing for string equality and numeric equality is
  2616. shown in this example:
  2617.  
  2618.      The strings "05" and "5" are different text strings, but are
  2619.      numerically equal.
  2620.  
  2621.  
  2622.  
  2623.                                     -50-
  2624.  
  2625. ===  IFERrorlevel  ===
  2626.  
  2627. Default key:   none
  2628. Description:   Test the Exit Code set by certain functions.
  2629.  
  2630. General form:
  2631.  
  2632.      {IFERrorlevel number,true,false}
  2633.  
  2634.           number
  2635.                A number from 0 to 255.  It will be compared to the last
  2636.                Exit Code that was set.
  2637.  
  2638.           true
  2639.                A label to GOTO or CALL if the Exit Code is greater than or
  2640.                equal to "number."
  2641.  
  2642.           false
  2643.                A label to GOTO or CALL if the Exit Code is less than
  2644.                "number."
  2645.  
  2646. NOTE:  If a target label is omitted (null), control will pass to the next
  2647. function.
  2648.  
  2649. Switches:
  2650.  
  2651.      C1 or C
  2652.           A CALL is performed on the label.  When the CALLed routine
  2653.           RETUrns, execution will continue following the IFERrorlevel.
  2654.  
  2655.      C0
  2656.           A GOTO is performed (default).
  2657.  
  2658. Examples:
  2659.  
  2660.      {iferror 1,abc,def}
  2661.           GOTO "abc" if Exit Code is greater than or equal to 1.  Else GOTO
  2662.           def.
  2663.  
  2664.      {ifer-c 2,gtr2}
  2665.           CALL "gtr2" if Exit Code is greater than or equal to 2  Else
  2666.           continue.
  2667.  
  2668. TIPS on using IFERrorlevel:
  2669.  
  2670.  *   The Exit Code is set by certain functions (e.g., EXECute-D, SHELl,
  2671.      RXMOdem, SXMOdem) and should normally be tested immediately following
  2672.      execution of those functions.
  2673.  
  2674.  *   EXECute without the "D" switch or Shell to DOS will normally set the
  2675.      Exit Code to 0.
  2676.  
  2677.  
  2678.  
  2679.                                     -51-
  2680.  
  2681.  *   Many programs return an Exit Code greater than 0 when the result is
  2682.      unsuccessful.  HS/Link, for example, will return an Exit Code of 1 or
  2683.      higher if the file transfer has failed.
  2684.  
  2685.  *   The value of the Exit Code is also stored in the string variable
  2686.      "_err" and may be tested with COMPare.
  2687.  
  2688.  
  2689. ===  IFEXist  ===
  2690.  
  2691. Default key:   none
  2692. Description:   Test for existence of a disk file or files.
  2693.  
  2694. General form:
  2695.  
  2696.      {IFEXist path\filename,true,false}
  2697.  
  2698.           path\filename
  2699.                A DOS path\filename.  If the path is omitted, the current
  2700.                directory will be used.  If wildcards are used the "true"
  2701.                condition will hold if any files match the specification.
  2702.  
  2703.           true
  2704.                A label to GOTO or CALL if the file exists.
  2705.  
  2706.           false
  2707.                A label to GOTO or CALL if no files match.
  2708.  
  2709. NOTE:  If a target label is omitted (null), control will pass to the next
  2710. function.
  2711.  
  2712. Switches:
  2713.  
  2714.      C1 or C
  2715.           A CALL is performed on the label.  When the CALLed routine
  2716.           RETUrns, execution will continue following the IFEXist.
  2717.  
  2718.      C0
  2719.           A GOTO is performed (default).
  2720.  
  2721. Examples:
  2722.  
  2723.      {ifex-c a:file.xyz,,m20}
  2724.           CALL "m20" if not found.
  2725.  
  2726.      {ifex c:\data\words.txt,345}
  2727.           GOTO "345" if found.
  2728.  
  2729.      {ifex c:\ul\*.rep,a01,a02}
  2730.           Using a wildcard.
  2731.  
  2732.  
  2733.  
  2734.                                     -52-
  2735.  
  2736. ===  INCRement  ===
  2737.  
  2738. Default key:   none
  2739. Description:   Add a number to a numeric variable.
  2740.  
  2741. Examples:
  2742.  
  2743.      {incr count}
  2744.           Add 1 to the variable "count".
  2745.  
  2746.      {incr oranges,1234}
  2747.           Add 1234 to "oranges".
  2748.  
  2749. The default for the second argument is 1.
  2750.  
  2751. If either argument or the result is out of range, then the variable will be
  2752. set to the string "ERROR".
  2753.  
  2754. If the variable is not numeric, the results will be unpredictable.
  2755.  
  2756. See also DECRement.
  2757.  
  2758.  
  2759. ===  INFOrm  ===
  2760.  
  2761. Default key:   none
  2762. Description:   Display an advisory message.
  2763.  
  2764. General form:
  2765.  
  2766.      {INFOrm string}
  2767.  
  2768.           string
  2769.                Message to be displayed.
  2770.  
  2771. Switches:
  2772.  
  2773.      Q1 or Q
  2774.           Query the user for a "Yes/No" response.  "Yes" will be the
  2775.           default if Enter is pressed.
  2776.  
  2777.           The Condition Flag will be set to "true" if the response is
  2778.           "yes".  It will be set to "false" if the response is "no".  Test
  2779.           with IFCOndition.
  2780.  
  2781.      Q0
  2782.           Query the user for a "Yes/No" response.  "No" will be the default
  2783.           if Enter is pressed.  The Condition Flag is set as above.
  2784.  
  2785.  
  2786.  
  2787.                                     -53-
  2788.  
  2789.      Dn
  2790.           Display the message for "n" seconds, then continue.  "n" may
  2791.           range from 1 to 999.  This switch is ignored if the "Q" switch is
  2792.           present.
  2793.  
  2794.      S1 or S
  2795.           An error sound will accompany the message (default).  The error
  2796.           sound is controlled with the "ers" item in the Setup File.
  2797.  
  2798.      S0
  2799.           No error sound will be made.
  2800.  
  2801. Examples:
  2802.  
  2803.      {inform Press a key to continue}
  2804.           Wait for Esc.
  2805.  
  2806.      {info-qs0 Overwrite the file?}
  2807.           Yes/No response, no error sound.
  2808.  
  2809.      {info-d3 Login now in progress}
  2810.           Display message for 3 seconds, then continue.
  2811.  
  2812. INFOrm will display a string in a pop-up box over the Terminal Screen. 
  2813. {COMMO} will normally wait for "Esc" to be pressed (switches can alter this
  2814. behavior).  The string length is limited by the width of the screen.
  2815.  
  2816. NOTE:  When the "Q" switch is used, Esc and Ctrl-Break will be ignored.
  2817.  
  2818. See also INPUt, GETString.
  2819.  
  2820.  
  2821. ===  INITmodem  ===
  2822.  
  2823. Default key:   Alt-O
  2824. Description:   Send Modem Initialization String.
  2825.  
  2826. Example:
  2827.  
  2828.      {init}
  2829.           No arguments
  2830.  
  2831.  
  2832. ===  INPUt  ===
  2833.  
  2834. Default key:   none
  2835. Description:   Input a string from the keyboard.
  2836.  
  2837. General form:
  2838.  
  2839.      {INPUt name,prompt}
  2840.  
  2841.  
  2842.  
  2843.                                     -54-
  2844.  
  2845.           name
  2846.                The name of a string variable.  The current value of this
  2847.                variable will appear in the input line.
  2848.  
  2849.           prompt
  2850.                A prompt string that will appear in the input window border.
  2851.  
  2852. Example:
  2853.  
  2854.      {input upfile,Enter a filename:}
  2855.           Input a string to the variable "upfile."
  2856.  
  2857. If 0 data characters are entered, the variable will be set to null.
  2858.  
  2859. NOTE:  If Esc is pressed, macro execution will be terminated unless an exit
  2860. label has been defined with SETEsc.
  2861.  
  2862. See also GETString, INFOrm.
  2863.  
  2864.  
  2865. ===  INSTring  ===
  2866.  
  2867. Default key:   none
  2868. Description:   Find a string within a string, return its position.
  2869.  
  2870. General form:
  2871.  
  2872.      {INSTring name,string}
  2873.  
  2874.           name
  2875.                The name of a variable (string to search in).
  2876.  
  2877.           string
  2878.                The string to search for.
  2879.  
  2880. Example:
  2881.  
  2882.      {inst line,abc}
  2883.           The variable "line" is searched for the string "abc".
  2884.  
  2885. INSTring will set the following:
  2886.  
  2887.      1)   The Condition Flag will be set to "true" if the string is found,
  2888.           to "false" if the string is not found.  Test with IFCOndition, no
  2889.           switches.
  2890.  
  2891.      2)   The starting position of the string will be returned in the
  2892.           built-in variable "_pos" (first character is "1").  "_pos" will
  2893.           be set to zero if the string is not found.
  2894.  
  2895.  
  2896.  
  2897.                                     -55-
  2898.  
  2899. ===  KEYStuff  ===
  2900.  
  2901. Default key:   none
  2902. Description:   Put key codes into the keyboard buffer.
  2903.  
  2904. Examples:
  2905.  
  2906.      {keys 1c0d}
  2907.           Put a carriage return into the keyboard buffer.
  2908.  
  2909.      {keys 1e41,6c00}
  2910.           Put an "A" in the keyboard buffer followed by Alt-F5.
  2911.  
  2912. This function is usually used prior to EXECuting programs, batch files or
  2913. DOS commands that require keys to be pressed.  It allows complete
  2914. automation without operator intervention.
  2915.  
  2916. TIPS on using KEYStuff:
  2917.  
  2918.  *   The key codes are given in hexadecimal (scan code/character code as
  2919.      received from the BIOS).  Press Alt-K in the Internal Editor to view
  2920.      any key code.
  2921.  
  2922.  *   One or more codes may be listed.  Do not insert extra spaces.
  2923.  
  2924.  *   Usually, when specifying an ASCII character, only the character code
  2925.      need be listed.  Thus the second example above could be written:  
  2926.  
  2927.           {keys 41,6c00}
  2928.  
  2929.  
  2930. ===  LENGth  ===
  2931.  
  2932. Default key:   none
  2933. Description:   Determine the length of a string.
  2934.  
  2935. Examples:
  2936.  
  2937.      {leng %line}
  2938.           Find the length of the string in the variable "line".
  2939.  
  2940.      {leng %line1%%line2}
  2941.           Find the combined length of "line1" and "line2".
  2942.  
  2943. The length will be returned in the built-in variable "_len".  If the string
  2944. is null, the length will be set to zero.
  2945.  
  2946.  
  2947. ===  LIGHts  ===
  2948.  
  2949. Default key:   none
  2950. Description:   Set Signal Lights toggle.
  2951.  
  2952.  
  2953.  
  2954.                                     -56-
  2955.  
  2956. Examples:
  2957.  
  2958.      {lights}
  2959.           Toggle Signal Lights on/off.
  2960.  
  2961.      {lights y}
  2962.           Turn on Signal Lights.
  2963.  
  2964.      {lights n}
  2965.           Turn off Signal Lights.
  2966.  
  2967.  
  2968. ===  LOCAlecho  ===
  2969.  
  2970. Default key:   none
  2971. Description:   Set Local Echo toggle.
  2972.  
  2973. Examples:
  2974.  
  2975.      {local}
  2976.           Toggle Local Echo on/off.
  2977.  
  2978.      {local y}
  2979.           Turn on Local Echo.
  2980.  
  2981.      {local n}
  2982.           Turn off Local Echo.
  2983.  
  2984.  
  2985. ===  LOOKfor  ===
  2986.  
  2987. Default key:   none
  2988. Description:   Look for strings in the modem input stream.
  2989.  
  2990. LOOKfor is used in conjunction with SSLOok, CALOok and GOLOok to scan for
  2991. as many as 16 strings at the same time.  When SSLOok, CALOok and GOLOok set
  2992. up additional strings to look for, the actual "looking" does not take place
  2993. until the LOOKfor executes.
  2994.  
  2995. Parameters controlling LOOKfor are set with the SETLook function and may be
  2996. changed at any time with another SETLook.  See the description of the
  2997. SETLook function for details.
  2998.  
  2999. Examples using LOOKfor only:
  3000.  
  3001.      {lookfor first name?}
  3002.           Look for the string "first name?"
  3003.  
  3004.      {look ^(COMMO^)}
  3005.           Look for the string "{COMMO}".
  3006.  
  3007.      When the string comes in, control will pass to the next function.
  3008.  
  3009.  
  3010.  
  3011.                                     -57-
  3012.  
  3013. Example construct using SSLOok/CALOok/GOLOok/LOOKfor:
  3014.  
  3015.                {setlook 60,hng,3,n|}
  3016.                {setv ss_r,|}
  3017.                  ...
  3018.      {:start}
  3019.                {golook label-a,target1}
  3020.                {calook start,label-b,target2}
  3021.                {sslook ss_r,target3}
  3022.                {golook ,target4}
  3023.                {lookfor target5} {send answer5}
  3024.                {goto label-c}
  3025.  
  3026.      {:label-a}     {hangup y} {goto cancel}
  3027.      {:label-b}     {send answer2} {call subr} {return}
  3028.      {:label-c}          ...
  3029.  
  3030.      In this example {COMMO} will look for five target strings.
  3031.  
  3032.      When a target specified in any of the CALOok, GOLOok or LOOKfor
  3033.      functions is received, the LOOKfor is cancelled.  It may be set up
  3034.      again by going to "start".
  3035.  
  3036.      When the target specified in the SSLOok is received, the string in the
  3037.      variable will be transmitted to the serial port.  The LOOKfor will
  3038.      continue to look for the same targets.
  3039.  
  3040.      The GOLOok function for target1 will GOTO "label-a" when the string
  3041.      comes in.  In the example control will pass to "cancel" (macro not
  3042.      shown).
  3043.  
  3044.      If target2 comes in, the CALOok function will set "start" as the
  3045.      return point and then CALL "label-b".  When this routine RETUrns,
  3046.      control returns to "start" and the five string LOOKfor will be set up
  3047.      again.
  3048.  
  3049.      If target3 is received, the string in the variable "ss_r" will be sent
  3050.      (in this case, a carriage return) and looking will continue.
  3051.  
  3052.      The GOLOok for target4 has a null label and control will pass to the
  3053.      function following the LOOKfor if that string comes in.  The "," must
  3054.      be present.
  3055.  
  3056.      If target5 comes in, control will pass to the function following the
  3057.      LOOKfor.
  3058.  
  3059. TIPS on creating LOOKfor strings:
  3060.  
  3061.  *   There should be just one space following the LOOKfor function name. 
  3062.      Any spaces beyond this point are part of the string.  The string ends
  3063.      at the right curly brace.
  3064.  
  3065.  
  3066.  
  3067.                                     -58-
  3068.  
  3069.  *   SSLOok/CALOok/GOLOok/Auto Receive strings begin immediately after the
  3070.      comma delimiter.  There should be no spaces unless they are part of
  3071.      the string.
  3072.  
  3073.  *   Strings may be up to 32 characters in length (control characters like
  3074.      "^M" count as one).  Upper/lower case is ignored.
  3075.  
  3076.  *   ANSI control sequences are filtered if ANSI or VT102 emulation is
  3077.      enabled.
  3078.  
  3079.  *   Short strings may not be unique enough, long strings may not match if
  3080.      there is line noise.
  3081.  
  3082.  *   Rules for representing special characters in
  3083.      SSLOok/CALOok/GOLOok/LOOKfor/Auto Receive strings are given in
  3084.      Appendix D.
  3085.  
  3086.  *   SSLOok, CALOok and GOLOok functions should immediately precede a
  3087.      LOOKfor (no string compares actually occur until the LOOKfor
  3088.      executes).  Up to 15 SSLOok/CALOok/GOLOok strings may be used in
  3089.      addition to the LOOKfor (up to 16 strings total).
  3090.  
  3091.  *   Use FILTER Capture Mode to determine the prompt to look for.
  3092.  
  3093.  *   If two or more strings cause a match at the same time, the LAST such
  3094.      string listed is the one acted upon (for example, if "abcdef" and
  3095.      "def" are listed and the string "abcdef" comes in).
  3096.  
  3097.  *   When an SSLOok causes a string to be sent, the LOOKfor timeout timer
  3098.      is restarted.
  3099.  
  3100. See also SSLOok, CALOok, GOLOok, SETLook.
  3101.  
  3102.  
  3103. ===  MACRo  ===
  3104.  
  3105. Default key:   Alt-M
  3106. Description:   Open Macro File window.
  3107.  
  3108. Examples:
  3109.  
  3110.      {macro}
  3111.           Open window at current position.
  3112.  
  3113.      {macro menu1}
  3114.           Open window at "menu1".
  3115.  
  3116. A string argument may be included to facilitate the creation of menus
  3117. within the Macro File.  The first occurrence of the argument string will
  3118. become the top line of the display when the window is opened.
  3119.  
  3120. The Selector Bar will be positioned on the first screen line that has a
  3121. left curly brace, if any.
  3122.  
  3123.  
  3124.  
  3125.                                     -59-
  3126.  
  3127.  
  3128. Here is an example of how to structure a menu using MACRo:
  3129.  
  3130.                                    | (this is past col. 80)
  3131.                                    | menu111
  3132.           Name of Menu             |
  3133.                                    |
  3134.                                    |
  3135.           Selection 1              | {goto sel1}
  3136.           Selection 2              | {goto sel2}
  3137.           Selection 3              | {goto sel3}
  3138.  
  3139.      {:af1} {macro menu111}
  3140.      {:sel1} ...
  3141.      {:sel2} ...
  3142.      {:sel3} ...
  3143.  
  3144. The upper line with "menu111" will be the top line of the screen.  Pressing
  3145. Alt-F1 will bring up the menu with the Selector Bar on Selection 1.  Macros
  3146. at "sel1", "sel2" and "sel3" will process the respective selections.
  3147.  
  3148. Note that the macro at "af1" to invoke the menu must be below the line with
  3149. "menu111" since it contains the string and would be found in the search. 
  3150. Also the macro at "af1" must be in the same Macro File (resident or
  3151. auxiliary) as the menu itself.
  3152.  
  3153. TIPS on using MACRo:
  3154.  
  3155.  *   The MACRo function always terminates the macro that is currently
  3156.      executing.
  3157.  
  3158.  *   Menu creation using MACRo cannot be used when the Macro File is
  3159.      compiled.  Use MENU instead.
  3160.  
  3161. See also MENU.
  3162.  
  3163.  
  3164. ===  MARK  ===
  3165.  
  3166. Default key:   none
  3167. Description:   Mark Dialing Directory entries for dialing.
  3168.  
  3169. Example:
  3170.  
  3171.      {mark joes-bbs,file-city}
  3172.           Mark entries for dialing.
  3173.  
  3174. Dialing Strings may be separated by spaces or commas.
  3175.  
  3176. {COMMO} will search the Dialing Directory for each string and mark the
  3177. first entry where a match is found.  Case is ignored.
  3178.  
  3179.  
  3180.  
  3181.                                     -60-
  3182.  
  3183. The strings may consist of any part of a Dialing Directory entry line
  3184. (including strings contained within curly braces), but must NOT contain any
  3185. spaces, commas or curly braces.
  3186.  
  3187. See also DIAL, UNMArk.
  3188.  
  3189.  
  3190. ===  MENU  ===
  3191.  
  3192. Default key:   none
  3193. Description:   Create a pop-up macro menu.
  3194.  
  3195. General form:
  3196.  
  3197.      {SETV _menu1,text1}
  3198.      {SETV _menu2,text2}
  3199.           ...
  3200.      {SETV _menuN,textN}
  3201.  
  3202.           text1
  3203.                Text to be placed on first information line in the pop-up
  3204.                window (third line down, counting from the top border).
  3205.  
  3206.                NOTE:  These text strings are simply information and have no
  3207.                effect on which macros will be executed.
  3208.  
  3209.           text2
  3210.                Text to be placed on second information line.
  3211.           ...
  3212.  
  3213.           textN
  3214.                Text to be placed on Nth information line.
  3215.  
  3216.      {SETV _mlabel,label1,label2,...}
  3217.  
  3218.           NOTE:  Labels are positional and may be omitted using null
  3219.           arguments for keys that aren't used.  See example 2 below.
  3220.  
  3221.           label1
  3222.                Label to GOTO if F1, A or 1 is pressed.  Any of the three
  3223.                keys will activate the macro at the first label.
  3224.  
  3225.           label2
  3226.                Label to GOTO if F2, B or 2 is pressed.
  3227.  
  3228.           ... etc.
  3229.  
  3230.      {SETV _menter,label}
  3231.  
  3232.           label
  3233.                Label to GOTO if Enter is pressed.
  3234.  
  3235.  
  3236.  
  3237.                                     -61-
  3238.  
  3239.      {SETV _mcolor,text,border}
  3240.  
  3241.           text
  3242.                Colors for the text area of the pop-up window.
  3243.  
  3244.           border
  3245.                Colors for the window border.
  3246.  
  3247.           NOTE:  The attributes are specified in the same manner as the
  3248.           colors in the Setup File (press F7 in the Internal Editor to
  3249.           display the Color Chart).  
  3250.  
  3251.      {MENU height,width,string}
  3252.  
  3253.           height
  3254.                Total number of rows from top to bottom of pop-up window,
  3255.                including borders.  Minimum is 5.
  3256.  
  3257.           width
  3258.                Total number of columns from left side to right side,
  3259.                including borders.  Minimum is 23.
  3260.  
  3261.           string
  3262.                Title string that will appear in the top border.
  3263.  
  3264. Example 1:
  3265.  
  3266.           {setv _menu1, F1  Call computer at work}
  3267.           {setv _menu3, F2  Call E-mail service}
  3268.           {setv _menu5, F3  Run offline mail reader}
  3269.           {setv _mlabel,work,mail,reader}
  3270.           {setv _mcolor,17,30}
  3271.           {menu 9,32,Daily Activity Menu} {}
  3272.  
  3273.      {:work}    ... macro to call work computer.
  3274.      {:mail}    ... macro to call E-mail service.
  3275.      {:reader}  ... macro to run offline reader.
  3276.  
  3277.      This menu specifies that function keys be pressed to activate the
  3278.      macros.  You could also press A or 1 instead of F1, B or 2 instead of
  3279.      F2, etc.  The macros may be as simple or as complex as desired to
  3280.      complete the task.
  3281.  
  3282. Example 2:
  3283.  
  3284.           {setv _menu1, [D]  Dialing Directory}
  3285.           {setv _menu4, [E]  Edit a file}
  3286.           {setv _menu2, [M]  Macro File}
  3287.           {setv _menu3, [Enter]  Shell to DOS (with swap)}
  3288.           {setv _mlabel,,,,ddir,edit,,,,,,,,mfile}
  3289.           {setv _menter,dos}
  3290.           {setv _mcolor,03,47}
  3291.           {menu 8,39,Common Commands} {}
  3292.  
  3293.  
  3294.  
  3295.                                     -62-
  3296.  
  3297.  
  3298.      {:ddir}  {dial} {}
  3299.      {:edit}  {input efile,Filename to Edit}
  3300.               {edit %efile} {}
  3301.      {:mfile} {macro}
  3302.      {:dos}   {shell-s} {}
  3303.  
  3304.      This menu uses "mnemonic" key labeling -- D for (D)ialing Directory,
  3305.      etc.  Notice that there are three empty positions in the "_mlabel"
  3306.      list prior to "ddir" and "edit".  These correspond to A, B and C,
  3307.      which are not used in this menu.  Then there are empty positions up to
  3308.      "mfile" (M).
  3309.  
  3310. TIPS on using MENU:
  3311.  
  3312.  *   The dimensions of the window are limited by the current size of the
  3313.      Terminal Screen.
  3314.  
  3315.  *   The total number of displayable lines is "height" less 4.  Lines in
  3316.      the window for which no "_menux" variable has been defined will be
  3317.      left blank.
  3318.  
  3319.  *   Up to 26 labels can be specified in each menu.  These correspond to
  3320.      pressing the letters A through Z.  The first 12 labels also correspond
  3321.      to pressing F1 through F12, while the first 9 labels correspond to
  3322.      pressing 1 through 9.
  3323.  
  3324.  *   The built-in variable "_msn" is set to the number of the menu
  3325.      selection when a menu key is pressed: 0 for Enter, 1 to 26 for A to Z,
  3326.      etc.
  3327.  
  3328.  *   All variables used to create the menu are automatically deleted from
  3329.      Variable Space after the menu is displayed. 
  3330.  
  3331.  *   The last colors used to display a menu will persist until they are
  3332.      changed (by setting the "_mcolor" variable).
  3333.  
  3334.  *   If Esc is pressed to exit the menu, macro execution continues in
  3335.      sequence following the MENU function.
  3336.  
  3337. See also MACRo.
  3338.  
  3339.  
  3340. ===  MULTiply  ===
  3341.  
  3342. Default key:   none
  3343. Description:   Multiply a numeric variable by a number.
  3344.  
  3345. Example:
  3346.  
  3347.      {mult money,10}
  3348.           Multiply "money" by 10.
  3349.  
  3350.  
  3351.  
  3352.                                     -63-
  3353.  
  3354. The multiplier (second argument) is limited to 65535 (default is 1).
  3355.  
  3356. If either argument or the result is out of range, then the variable will be
  3357. set to the string "ERROR".
  3358.  
  3359. If the variable is not numeric, the results will be unpredictable.
  3360.  
  3361.  
  3362. ===  NOCArrier  ===
  3363.  
  3364. Default key:   none
  3365. Description:   Sets/resets a macro to execute when carrier detect is lost.
  3366.  
  3367. Switches:
  3368.  
  3369.      E or E1
  3370.           Enable the "carrier lost" logic as if a connection had been made
  3371.           using the Auto Dialer.  If no label is specified when using the
  3372.           "E" switch, the current label will be retained.
  3373.  
  3374.      E0
  3375.           Do not enable the "carrier lost" logic (default).
  3376.  
  3377. Examples:
  3378.  
  3379.      {noca carrlost}
  3380.           GOTO the label "carrlost" when the carrier detect signal drops.
  3381.  
  3382.      {noca}
  3383.           Cancel the carrier lost label.
  3384.  
  3385. This function is used to modify the label defined by the "ncr" item in the
  3386. Setup File.  See "Alt-G  Edit Setup File" in Part I (COMMO.DOC) for details
  3387. and restrictions on this feature.
  3388.  
  3389.  
  3390. ===  NOOP  ===
  3391.  
  3392. Default key:   none
  3393. Description:   No-op function, does nothing
  3394.  
  3395. Example:
  3396.  
  3397.      {noop}
  3398.           No arguments.
  3399.  
  3400.  
  3401. ===  OFFLog  ===
  3402.  
  3403. Default key:   none
  3404. Description:   Make an {Off} entry in the Usage Log.
  3405.  
  3406.  
  3407.  
  3408.                                     -64-
  3409.  
  3410. Example:
  3411.  
  3412.      {offlog}
  3413.           No arguments.
  3414.  
  3415. This function is useful on systems that do not support the carrier detect
  3416. signal.
  3417.  
  3418. NOTE:  An {Off} entry will be made only if an {On} entry was made at
  3419. connection time.
  3420.  
  3421.  
  3422. ===  PARMs  ===
  3423.  
  3424. Default key:   Alt-P
  3425. Description:   Set Current Terminal Parameters
  3426.  
  3427. General form:
  3428.  
  3429.      {PARMs speed,format,comport,terminal-type,delay}
  3430.  
  3431.           speed
  3432.                The bps rate: 2400, 38400, etc.
  3433.  
  3434.           format
  3435.                The data format: 8n1, 7e1, etc.
  3436.  
  3437.           comport
  3438.                The serial port number: 1, 2, 3 or 4.
  3439.  
  3440.           terminal
  3441.                The terminal-type: A, V or T.
  3442.  
  3443.           delay
  3444.                The inter-character delay factor: 0-999.
  3445.  
  3446. Examples:
  3447.  
  3448.      {parms 38400,8,1,,20}
  3449.           Set 38400 bps, 8n1, Com1, delay=20.
  3450.  
  3451.      {parms ,,4,V}
  3452.           Set Com4 VT102.
  3453.  
  3454.      {parms 19200,7o1}
  3455.           Set 19200 bps, 7o1.
  3456.  
  3457. IMPORTANT!  Omitted parameters are not changed.
  3458.  
  3459. This function will change the current parameters, but has no effect on the
  3460. parameters set when dialing.
  3461.  
  3462. See also DPARms.
  3463.  
  3464.  
  3465.  
  3466.                                     -65-
  3467.  
  3468.  
  3469.  
  3470. ===  PASSword  ===
  3471.  
  3472. Default key:   Alt-W
  3473. Description:   Send current password.
  3474.  
  3475. Example:
  3476.  
  3477.      {password}
  3478.           No arguments.
  3479.  
  3480. The current password is obtained from the Dialing Directory entry whenever
  3481. a number is dialed.  If no password is specified no characters will be
  3482. sent.
  3483.  
  3484.  
  3485. ===  PAUSe  ===
  3486.  
  3487. Default key:   none
  3488. Description:   Pause for a time interval.
  3489.  
  3490. Switches:
  3491.  
  3492.      T or T1
  3493.           Time is specified in DOS clock ticks (there are 18 clock ticks
  3494.           per second).
  3495.  
  3496.      T0
  3497.           Time is specified in seconds (default).
  3498.  
  3499. Examples:
  3500.  
  3501.      {pause 25}
  3502.           Pause for 25 seconds.
  3503.  
  3504.      {pause-t 9}
  3505.           Pause for 9 clock ticks (one half second).
  3506.  
  3507. NOTE:  Incoming characters displayed during a PAUSe function are not seen
  3508. by subsequent SSLOok/CALOok/GOLOok/LOOKfor functions.
  3509.  
  3510.  
  3511. ===  POPStack  ===
  3512.  
  3513. Default key:   none
  3514. Description:   Pop an element from the macro stack.
  3515.  
  3516.  
  3517.  
  3518.                                     -66-
  3519.  
  3520. Switches:
  3521.  
  3522.      C1 or C
  3523.           Clear all elements from the stack.
  3524.  
  3525.      C0
  3526.           Pop the top element (default).
  3527.  
  3528. Examples:
  3529.  
  3530.      {pops}
  3531.           Pop the top element.
  3532.  
  3533.      {pops-c}
  3534.           Clear the stack.
  3535.  
  3536. POPStack throws away the top element on the macro stack.  This element
  3537. would have been used by the next RETUrn function.
  3538.  
  3539. See also CALL, RETUrn, PUSHstack.
  3540.  
  3541.  
  3542. ===  PRINtlog  ===
  3543.  
  3544. Default key:   Alt-2
  3545. Description:   Set Print Log toggle.
  3546.  
  3547. Examples:
  3548.  
  3549.      {print}
  3550.           Toggle Print Log on/off.
  3551.  
  3552.      {print y}
  3553.           Turn on Print Log.
  3554.  
  3555.      {print n}
  3556.           Turn off Print Log.
  3557.  
  3558.  
  3559. ===  PUSHstack  ===
  3560.  
  3561. Default key:   none
  3562. Description:   Push a return point onto the macro stack.
  3563.  
  3564. Examples:
  3565.  
  3566.      {push}
  3567.           Push the current location.
  3568.  
  3569.      {push abc}
  3570.           Push the location "abc".
  3571.  
  3572.  
  3573.  
  3574.                                     -67-
  3575.  
  3576. When there are no arguments, the location pushed is the location of the
  3577. PUSHstack function itself (i.e., it will be executed again when a RETUrn is
  3578. encountered).
  3579.  
  3580. PUSHstack will push a return point onto the macro stack without
  3581. transferring control to the location (control continues in sequence).  A
  3582. subsequent RETUrn will transfer control to the location that was pushed.
  3583.  
  3584. POPStack will remove the top stack element without transferring control to
  3585. it (control continues in sequence).
  3586.  
  3587. TIPS on using PUSHstack:
  3588.  
  3589.  *   The return point will include the name of the current auxiliary file
  3590.      if the PUSHstack function is located in the auxiliary.
  3591.  
  3592.  *   PUSHstack cannot save a location that is in a Macro File that is not
  3593.      currently loaded.
  3594.  
  3595. See also CALL, RETUrn, POPStack.
  3596.  
  3597.  
  3598. ===  RCLOse  ===
  3599.  
  3600. Default key:   none
  3601. Description:   Close the read file.
  3602.  
  3603. Example:
  3604.  
  3605.      {rclose}
  3606.           No arguments.
  3607.  
  3608. NOTE:  The read file will be closed automatically in the following
  3609. situations:
  3610.  
  3611.      1)   When an attempt is made to read past the end of the file.
  3612.      2)   When the macro terminates (STOP, EXIT, etc.).
  3613.  
  3614. See also ROPEn, READ.
  3615.  
  3616.  
  3617. ===  READ  ===
  3618.  
  3619. Default key:   none
  3620. Description:   Read a line from the read file to a variable.
  3621.  
  3622. Example:
  3623.  
  3624.      {read nextline}
  3625.           Read the next line in the file into the variable "nextline."
  3626.  
  3627.  
  3628.  
  3629.                                     -68-
  3630.  
  3631. TIPS on reading files:
  3632.  
  3633.  *   A file must be open for reading or a Macro Error will result.
  3634.  
  3635.  *   Each READ will get the next line in the file (lines are terminated by
  3636.      carriage return and linefeed).
  3637.  
  3638.  *   When an attempt is made to read past the end of file, control will
  3639.      GOTO the label specified in the ROPEn.  If no label was specified or
  3640.      if the label was invalid, control will continue in sequence.  In
  3641.      either case the file is automatically closed and the variable is set
  3642.      to null.
  3643.  
  3644.  *   READ will set the Exit Code to 0 unless the end of file was
  3645.      encountered, in which case it will be set to 1.  The Exit Code is
  3646.      stored in the built-in variable "_err" and can be tested with the
  3647.      IFERrorlevel function.
  3648.  
  3649.  *   ALL control characters (below ASCII 28) will be discarded, including
  3650.      the carriage return/linefeed that terminates the line.
  3651.  
  3652.  *   Lines longer than 240 characters will be truncated to a length of 240.
  3653.  
  3654. See also ROPEn, RCLOse
  3655.  
  3656.  
  3657. ===  RETUrn  ===
  3658.  
  3659. Default key:   none
  3660. Description:   Return from a CALLed macro.
  3661.  
  3662. Example:
  3663.  
  3664.      {return}
  3665.           No arguments.
  3666.  
  3667. This function will return control to the last location pushed onto the
  3668. macro stack (by CALL, PUSHstack, etc.).  The location may reside in a Macro
  3669. File that is not currently loaded (loading will occur automatically).
  3670.  
  3671. TIPS on using RETUrn:
  3672.  
  3673.  *   If a RETUrn is encountered and no elements remain on the macro stack,
  3674.      a STOP will occur.  This is useful in macros that are CALLed and also
  3675.      used standalone (such as protocol file transfer macros).
  3676.  
  3677.  *   If the macro filename popped from the macro stack is the same as the
  3678.      current auxiliary file, no load will occur.
  3679.  
  3680. See also CALL, CALOok, DIAL, PUSHstack, POPStack.
  3681.  
  3682.  
  3683.  
  3684.                                     -69-
  3685.  
  3686. ===  ROPEn  ===
  3687.  
  3688. Default key:   none
  3689. Description:   Open a file for reading.
  3690.  
  3691. General Form:
  3692.  
  3693.      {ROPEn path\filename,label}
  3694.  
  3695.           path\filename
  3696.                The path\filename of the file to open.
  3697.  
  3698.           label
  3699.                A label to GOTO when a READ is attempted at the end of the
  3700.                file.
  3701.  
  3702.                IMPORTANT!  If the READ is in a CALLed subroutine, be sure
  3703.                to execute a RETUrn or POPS at the label.
  3704.  
  3705. Example:
  3706.  
  3707.      {ropen c:\bbs\file.txt,nomore}
  3708.           Open the file and set the label "nomore" to GOTO when the end of
  3709.           the file is reached.
  3710.  
  3711. TIPS on using ROPEn:
  3712.  
  3713.  *   Only one file may be opened for reading (and one for writing).
  3714.  
  3715.  *   The file will be automatically closed when the end of the file is
  3716.      encountered during a READ (whether or not a label is specified).  An
  3717.      RCLOse is not needed in this situation.
  3718.  
  3719. See also READ, RCLOse.
  3720.  
  3721.  
  3722. ===  RTRAn  ===
  3723.  
  3724. Default key:   none
  3725. Description:   Maintain Receive Translate Table.
  3726.  
  3727. Switches:
  3728.  
  3729.      I1 or I
  3730.           Initialize Receive Translate Table to default values (consecutive
  3731.           0 to 255).
  3732.  
  3733.      I0
  3734.           Do not initialize (default).
  3735.  
  3736.  
  3737.  
  3738.                                     -70-
  3739.  
  3740. Examples:
  3741.  
  3742.      {rtran y}
  3743.           Turn receive translation ON.
  3744.  
  3745.      {rtran-i n}
  3746.           Initialize the table and turn it OFF.
  3747.  
  3748.      {rtran 26,0}
  3749.           Change ASCII 26 to null (ASCII 0, which will not display).
  3750.  
  3751.      {rtran-i y,#8,224,240}
  3752.           Initialize the table, turn receive translation ON, change ASCII
  3753.           224 to 240, 225 to 241, ..., 231 to 247.  
  3754.  
  3755.      {rtran}
  3756.           Toggle receive translation ON/OFF.
  3757.  
  3758.      {rtran #13,65,78,#13,78,65,#13,97,110,#13,110,97}
  3759.           ROT13 translation.  This exchanges each letter in the first half
  3760.           of the alphabet with the corresponding letter from the second
  3761.           half (and vice-versa).
  3762.  
  3763. Rules for RTRAn arguments are the same as for the {rtr=} item in the Setup
  3764. File.  In addition, "n" may be used as the first argument to turn receive
  3765. translation OFF at any time.
  3766.  
  3767. See "Edit Setup File" in Part I (COMMO.DOC) for details and more examples.
  3768.  
  3769. TIPS on using RTRAn:
  3770.  
  3771.  *   Some control characters are unaffected by translation when certain
  3772.      features are enabled.  Examples:  XON (17) and XOFF (19) are not
  3773.      translated when Software Flow Control is on.  ENQ (5) is not
  3774.      translated when ENQ/ACK emulation is on.
  3775.  
  3776.  *   When the Capture Mode is set to RAW, data will be captured prior to
  3777.      translation.  FILTER and SCREEN captures will contain translated data.
  3778.  
  3779.  *   LOOKfor will always see translated data.  Use FILTER Capture Mode to
  3780.      see what LOOKfor sees.
  3781.  
  3782.  *   In GETString, incoming data (as well as locally typed characters) will
  3783.      be translated with the Receive Translate Table (it may be necessary to
  3784.      turn receive translation off during certain GETString functions).
  3785.  
  3786. See also STRAn.
  3787.  
  3788.  
  3789. ===  RXMOdem  ===
  3790.  
  3791. Default key:   none
  3792. Description:   Receive a file using the Xmodem protocol.
  3793.  
  3794.  
  3795.  
  3796.                                     -71-
  3797.  
  3798.  
  3799. Switches:
  3800.  
  3801.      See RYMOdem (switches are the same).
  3802.  
  3803. Example:
  3804.  
  3805.      {rxmo-ya c:\dl\file.zip}
  3806.           Receive "file.zip", overwrite the file if it exists, sound the
  3807.           alarm.
  3808.  
  3809. Only one file may be received with each RXMOdem function (the file must be
  3810. explicitly named, but need not be given the same name as on the remote
  3811. system).
  3812.  
  3813. See RYMOdem for tips that apply to both RXMOdem and RYMOdem.
  3814.  
  3815.  
  3816. ===  RYMOdem  ===
  3817.  
  3818. Default key:   none
  3819. Description:   Receive files using the Ymodem Batch protocol.
  3820.  
  3821. Switches:
  3822.  
  3823.      NOTE: N, D, A and W switches are the same as for RZMOdem.
  3824.  
  3825.      C1 or C
  3826.           Use CRC error correction (default).
  3827.  
  3828.      C0
  3829.           Use Checksum error correction.
  3830.  
  3831.      G1 or G
  3832.           Use streaming (fast) transfer method.
  3833.  
  3834.           IMPORTANT!  Use only with error-correcting modems or direct
  3835.           connections between computers.
  3836.  
  3837.      G0
  3838.           Use normal (error-correcting) transfer method (default).
  3839.  
  3840.      Y1 or Y
  3841.           Overwrite an existing file when a received file has the same name
  3842.           (the existing file will be erased).
  3843.  
  3844.      Y0
  3845.           Cancel the transfer if a received file has the same name as an
  3846.           existing file (default).
  3847.  
  3848.  
  3849.  
  3850.                                     -72-
  3851.  
  3852. Examples:
  3853.  
  3854.      {rymo-ya %dldir}
  3855.           Receive files into the download directory, overwrite a file if it
  3856.           exists, sound the alarm.
  3857.  
  3858.      {rymo-gw3}
  3859.           Receive files using the "G" method into the current directory. 
  3860.           Wait 3 seconds before returning to the Terminal Screen.
  3861.  
  3862. Ymodem is a "batch" protocol that will receive multiple files.  Filenames
  3863. are transmitted by the sender and are used to name files at the receiving
  3864. end.  A filename "collision" will cause the transfer to cancel unless the
  3865. "Y" switch is used.  File sizes are also transmitted by the sender and are
  3866. used to truncate the file to the proper size.
  3867.  
  3868. TIPS on using RYMOdem and RXMOdem:
  3869.  
  3870.  *   The "G" method is specified by the receiver.  Be sure that the sender
  3871.      allows it before starting.
  3872.  
  3873.  *   Block size is established by the sender and may be changed on a block-
  3874.      by-block basis.
  3875.  
  3876.  *   Some conditions that will cancel a transfer:
  3877.        1)  10 consecutive errors.
  3878.        2)  Any error when "G" method is used.
  3879.        3)  File exists and the "Y" switch is not present.
  3880.        4)  The sender has transmitted CAN (^X) characters.
  3881.        5)  Loss of carrier.
  3882.  
  3883.  *   The Exit Code (test with IFER) will be set at the end of the transfer
  3884.      and will also be stored in the variable "_err".  0 means all files
  3885.      were transferred successfully.  1 means one or more files in the batch
  3886.      were not completed.
  3887.  
  3888.  *   If the Usage Log is enabled, an entry will be made after each file is
  3889.      transferred (or if a transfer is cancelled).
  3890.  
  3891.  
  3892. ===  RZMOdem  ===
  3893.  
  3894. Default key:   none
  3895. Description:   Receive a file using the Zmodem protocol.
  3896.  
  3897. Switches:
  3898.  
  3899.      R1 or R
  3900.           Resume like-named files.  If the incoming file is longer, the
  3901.           transfer will resume at the end of the existing file.  No check
  3902.           is made to determine if the common portion of the file is
  3903.           identical.
  3904.  
  3905.  
  3906.  
  3907.                                     -73-
  3908.  
  3909.      N1 or N
  3910.           Rename incoming files if like-named files exists.  A letter "A"
  3911.           through "Z" will be used in place of the last character of
  3912.           "filename.ext".
  3913.  
  3914.      Y1 or Y
  3915.           Overwrite like-named files.  The existing file will be deleted at
  3916.           the start of the transfer.
  3917.  
  3918.      D1 or D
  3919.           Cancel transfer if carrier detect is lost (default).
  3920.  
  3921.           NOTE:  If carrier detect is off when the transfer is started,
  3922.           this switch will behave as if "D0" had been set.
  3923.  
  3924.      D0
  3925.           Ignore state of carrier detect.
  3926.  
  3927.      A1 or A
  3928.           Sound the alarm at the end of the transfer.
  3929.  
  3930.      A0
  3931.           Do not sound the alarm (default).
  3932.  
  3933.      W
  3934.           Wait for a keypress at end of transfer.
  3935.  
  3936.      Wn
  3937.           Wait for "n" seconds, "n" may range from 0 to 999.  Press a key
  3938.           to cancel the wait.
  3939.  
  3940.           Note:  Default (no "W" switch) is no wait.
  3941.  
  3942. The "R", "N" and "Y" switches are mutually exclusive (use only one).
  3943.  
  3944. Example:
  3945.  
  3946.      {rzmo-ra %dldir}
  3947.           Receive files into the download directory, resume partial files,
  3948.           sound the alarm.
  3949.  
  3950. TIPS on using RZMOdem:
  3951.  
  3952.  *   The sender may also request that the file be "resumed."  The "N" and
  3953.      "Y" switches will override this request.
  3954.  
  3955.  *   If a like-named file exists in the download directory and no action is
  3956.      specified, the file will be "skipped."
  3957.  
  3958.  *   Some conditions that will cancel a transfer:
  3959.        1)  20 consecutive errors.
  3960.        2)  The sender has cancelled.
  3961.        3)  Unable to open a file.
  3962.  
  3963.  
  3964.  
  3965.                                     -74-
  3966.  
  3967.        4)  Disk is full.
  3968.        5)  Loss of carrier.
  3969.  
  3970.  *   The Exit Code (test with IFER) will be set at the end of the transfer
  3971.      and will also be stored in the variable "_err".  0 means all files
  3972.      were transferred successfully.  1 means one or more files in the batch
  3973.      were not completed.
  3974.  
  3975.  *   If the Usage Log is enabled, an entry will be made after each file is
  3976.      transferred (or if a transfer is cancelled).
  3977.  
  3978.  
  3979. ===  SCREen  ===
  3980.  
  3981. Default key:   Alt-I
  3982. Description:   Screen Image Save.
  3983.  
  3984. Examples:
  3985.  
  3986.      {screen}
  3987.           Open Screen Image Save window.
  3988.  
  3989.      {screen y}
  3990.           Append screen image to current file.
  3991.  
  3992.      {screen y,commo.scr}
  3993.           Append screen image to indicated file. (and change current
  3994.           path\filename).
  3995.  
  3996.      {screen n,c:\file.xyz}
  3997.           Change current screen image path\filename (don't save screen to
  3998.           file).
  3999.  
  4000.  
  4001. ===  SCROllback  ===
  4002.  
  4003. Default key:   Alt-K
  4004. Description:   Display Scrollback Buffer
  4005.  
  4006. Example:
  4007.  
  4008.      {scroll}
  4009.           No arguments.
  4010.  
  4011.  
  4012. ===  SEND  ===
  4013.  
  4014. Default key:   none
  4015. Description:   Send a string to the modem (serial port).
  4016.  
  4017. Switches:
  4018.  
  4019.  
  4020.  
  4021.                                     -75-
  4022.  
  4023.      N1 or N
  4024.           Do NOT convert control characters.
  4025.  
  4026.      N0
  4027.           Convert control characters as described in Appendix D (default).
  4028.  
  4029.      B1 or B
  4030.           Byte mode.  Characters are represented by decimal or hex numbers,
  4031.           separated by commas.  Hex numbers are preceded by a "0" and all
  4032.           characters from 0 to 255 may be sent.  There is no conversion, no
  4033.           translation and no local echo.
  4034.  
  4035.      B0
  4036.           Normal string mode (default).
  4037.  
  4038. Examples:
  4039.  
  4040.      {send Firstname|~~Lastname|~~%_pass%|}
  4041.           Send first and last names with carriage returns and 1 second
  4042.           delays, then send the current password and a <cr>.
  4043.  
  4044.      {send ^[^[}
  4045.           Send two <esc> characters.
  4046.  
  4047.      {send  }
  4048.           Send a space (there must be two spaces, the first is the
  4049.           separator).
  4050.  
  4051.      {send %line}
  4052.           Send the string in the variable "line".
  4053.  
  4054.      {send-n ^A|~}
  4055.           Send the characters as written.  Do not convert the special
  4056.           characters.
  4057.  
  4058.      {send-b 123,043,04f,77,04d,79,07d}
  4059.           Send "{COMMO}"
  4060.  
  4061.  
  4062. ===  SETDial  ===
  4063.  
  4064. Default key:   none
  4065. Description:   Set parameters for dialing.
  4066.  
  4067. Examples:
  4068.  
  4069.      {setdial 60,15}
  4070.           Set the dialing cycle timer to 60 seconds and the Inter-dial
  4071.           Delay to 15 seconds.
  4072.  
  4073.      {setd ,3}
  4074.           Change only the Inter-dial Delay timer.
  4075.  
  4076.  
  4077.  
  4078.                                     -76-
  4079.  
  4080. The first argument is the dialing cycle time limit.  This is the number of
  4081. seconds {COMMO} will allow after sending the dial command to the modem. 
  4082. Range is from 1 to 999.
  4083.  
  4084. The second argument is the inter-dial delay timer.  This is the number of
  4085. seconds before {COMMO} dials the next number.  Range is from 1 to 999.
  4086.  
  4087. NOTE:  Changes to dialing parameters override the Setup File values and
  4088. remain in effect until {COMMO} is exited.
  4089.  
  4090. See also DIAL.
  4091.  
  4092.  
  4093. ===  SETEsc  ===
  4094.  
  4095. Default key:   none
  4096. Description:   Define a label to GOTO when Esc is pressed.
  4097.  
  4098. General form:
  4099.  
  4100.      {setesc label}
  4101.  
  4102.           label
  4103.                A label to GOTO when the user presses Esc during macro
  4104.                execution.
  4105.  
  4106. Switches:
  4107.  
  4108.      P1 or P
  4109.           The user will be prompted with, "A macro is running.  Terminate
  4110.           it?."  If the user answers "no," macro execution will continue as
  4111.           if nothing had happened.  If "yes," the macro will be STOPped and
  4112.           the macro at the label will be started.  If the label does not
  4113.           exist, a STOP will be executed.  P1 is the default.
  4114.  
  4115.      P0
  4116.           The user will not be prompted.  The macro will be STOPped and the
  4117.           macro at the label will be started.  If the label does not exist,
  4118.           a STOP will be executed.
  4119.  
  4120. Examples:
  4121.  
  4122.      {setesc finish}
  4123.           GOTO label, with prompt.
  4124.  
  4125.      {sete-p0 done}
  4126.           GOTO label, without prompt.
  4127.  
  4128.      {setesc}
  4129.           Reset to no label (STOP on Esc).
  4130.  
  4131.  
  4132.  
  4133.                                     -77-
  4134.  
  4135. This function is used to "capture" the Esc key during macro execution.  It
  4136. can help to prevent accidental macro terminations.
  4137.  
  4138. NOTE:  In the various command windows, Esc is normally used to exit the
  4139. window.  Use Ctrl-Break to bring up the prompt.
  4140.  
  4141.  
  4142. ===  SETGet  ===
  4143.  
  4144. Default key:   none
  4145. Description:   Set parameters for GETString functions.
  4146.  
  4147. General form:
  4148.  
  4149.      {SETGet seconds,label,y/n/l,string}
  4150.  
  4151.           seconds
  4152.                GETString timeout.  If a character is not entered in the
  4153.                specified amount of time, the macro in the second argument
  4154.                will be started.  May be 0 to 999.  Default is 0 (disabled).
  4155.  
  4156.           label
  4157.                Timeout macro.  Macro to GOTO if the time in the first
  4158.                argument expires.  If no macro is specified or if the macro
  4159.                label is invalid, control will pass to the function
  4160.                following the GETString.  Default is no macro.
  4161.  
  4162.                Note that if the timer expires no variable assignment will
  4163.                be made.  Any previous assignment will be unaltered.
  4164.  
  4165.                IMPORTANT!  If the GETString is in a CALLed subroutine, be
  4166.                sure to execute a RETUrn or POPS at the label.
  4167.  
  4168.           y/n/l
  4169.                Echo Status.  If this is "yes", characters entered at the
  4170.                local or remote terminals will be echoed back to the remote
  4171.                and displayed locally.  This is the default.
  4172.  
  4173.                If "no", characters will not be echoed to either location.
  4174.  
  4175.                If "local", characters will be displayed locally, but not
  4176.                echoed to the remote.  This should be used when the remote
  4177.                is a host system.
  4178.  
  4179.                IMPORTANT!  This setting is independent of Local Echo.  Turn
  4180.                on Local Echo if necessary for local display of data
  4181.                transmitted with SEND, ASCIiup, etc.
  4182.  
  4183.  
  4184.  
  4185.                                     -78-
  4186.  
  4187.           string
  4188.                Terminator response.  This string will be sent and/or
  4189.                displayed locally (in accord with the Echo Status) when a
  4190.                carriage return is received (input terminated).  This is
  4191.                typically a carriage return/linefeed.  May be up to 32
  4192.                characters.  Default is no string.
  4193.  
  4194. Example:
  4195.  
  4196.      {setg 120,noget,y,^m^j}
  4197.           Set GETString parameters.
  4198.  
  4199.  
  4200. The SETGet function will set parameters for all subsequent GETString
  4201. functions.  It may be executed at any time to modify the parameters.
  4202.  
  4203. When macro execution terminates, the parameters will be reset to the
  4204. default values.
  4205.  
  4206. Default arguments are:
  4207.  
  4208.      GETString timeout        0 (disabled)
  4209.      Timeout macro            none 
  4210.      Echo status              y (echo on)
  4211.      Terminator response      none
  4212.  
  4213. IMPORTANT!  Null arguments in the SETGet function will be set to these
  4214. defaults.
  4215.  
  4216. See also GETString.
  4217.  
  4218.  
  4219. ===  SETLook  ===
  4220.  
  4221. Default key:   none
  4222. Description:   Set parameters for LOOKfor functions.
  4223.  
  4224. General form:
  4225.  
  4226.      {SETLook seconds,label,seconds,string}
  4227.  
  4228.           seconds
  4229.                LOOKfor timeout.  Maximum time in seconds to look for
  4230.                strings.  If no string is found in the allotted time, the
  4231.                macro in the second argument will be started.  May be 0 to
  4232.                999.  Note that this timer is restarted whenever a string is
  4233.                sent by SSLOok.  Default is 0 (disabled).
  4234.  
  4235.           label
  4236.                Timeout macro.  Macro to GOTO if the time in the first
  4237.                argument expires.  If no macro is specified or if the macro
  4238.                label is invalid, control will pass to the function
  4239.                following the LOOKfor.
  4240.  
  4241.  
  4242.  
  4243.                                     -79-
  4244.  
  4245.  
  4246.                IMPORTANT!  If the LOOKfor is in a CALLed subroutine, be
  4247.                sure to execute a RETUrn or POPS at the label.
  4248.  
  4249.           seconds
  4250.                Prompt timeout.  During a LOOKfor function unwanted prompts
  4251.                may appear like "Press any key" or "More [Y/n]", etc.  This
  4252.                argument is the time in seconds to wait at a prompt (no
  4253.                input from the modem) before sending the string in the
  4254.                fourth argument.  Usually you would send "|" or "n|".
  4255.  
  4256.                When the response string is sent the timer is restarted,
  4257.                allowing any number of prompts to be satisfied (until the
  4258.                LOOKfor itself is satisfied or times out).
  4259.  
  4260.                The timer will also be restarted if any keys are typed while
  4261.                waiting.  This allows a manual response to a prompt which
  4262.                the macro does not handle.
  4263.  
  4264.                IMPORTANT!  The prompt timeout should be long enough (or
  4265.                disabled entirely) to prevent the response from being sent
  4266.                when there is a long delay without a prompt.  This might
  4267.                occur right after connection while the BBS software is
  4268.                loading or when a "door" program is loading.
  4269.  
  4270.                Failure to heed this warning will result in "n" responses to
  4271.                "First name?" and other undesirable effects.
  4272.  
  4273.                May be 0 to 999.  Default is 0 (disabled).
  4274.  
  4275.           string
  4276.                Prompt response.  String to send when the time in the third
  4277.                argument runs out.  May be up to 32 characters.  Default is
  4278.                no string.
  4279.  
  4280. Example:
  4281.  
  4282.      {setl 60,abc,4,n|}
  4283.           Set LOOKfor parameters
  4284.  
  4285.  
  4286. The SETLook function will set parameters for subsequent LOOKfor functions
  4287. and may be executed at any time to modify the parameters.
  4288.  
  4289. When macro execution terminates, the parameters will be reset to the
  4290. default values.
  4291.  
  4292. Default arguments are:
  4293.  
  4294.      LOOKfor timeout     0 (disabled)
  4295.      Timeout macro       none 
  4296.      Prompt timeout      0 (disabled)
  4297.      Prompt response     none
  4298.  
  4299.  
  4300.  
  4301.                                     -80-
  4302.  
  4303.  
  4304. IMPORTANT!  Null arguments in the SETLook function will revert to these
  4305. defaults.
  4306.  
  4307. See also LOOKfor, SSLOok, CALOok, GOLOok.
  4308.  
  4309.  
  4310. ===  SETR  ===
  4311.  
  4312. Default key:   none
  4313. Description:   Define a label to GOTO when a Macro Error occurs.
  4314.  
  4315. Examples:
  4316.  
  4317.      {setr error}
  4318.           GOTO "error" when any Macro Error occurs.
  4319.  
  4320.      {setr}
  4321.           Reset to no label.
  4322.  
  4323. SETR allows a macro to get control when a Macro Error occurs.  All macro
  4324. parameters (see STOP) will be reset after the error (including the SETR
  4325. label).
  4326.  
  4327. TIPS on using SETR:
  4328.  
  4329.  *   The built-in variable "_met" will contain an error message describing
  4330.      the most recent error.
  4331.  
  4332.  *   Variable Space will not be changed.
  4333.  
  4334.  *   If the specified label does not exist, or if no label is currently
  4335.      specified, {COMMO} will STOP and indicate the location of the error.
  4336.  
  4337.  
  4338. ===  SETUp  ===
  4339.  
  4340. Default key:   Alt-G
  4341. Description:   Edit Setup File.
  4342.  
  4343. Example:
  4344.  
  4345.      {setup}
  4346.           No arguments.
  4347.  
  4348.  
  4349. ===  SETVariable  ===
  4350.  
  4351. Default key:   none
  4352. Description:   Assign a string to a variable name.
  4353.  
  4354.  
  4355.  
  4356.                                     -81-
  4357.  
  4358. General form:
  4359.  
  4360.      {SETVariable name,string}
  4361.  
  4362.           name
  4363.                The name of the variable to which the string will be
  4364.                assigned.
  4365.  
  4366.           string
  4367.                The string may be the name of another {COMMO} variable or an
  4368.                environment variable.  In these cases further expansion is
  4369.                controlled by switches (see below).
  4370.  
  4371. Switches:
  4372.  
  4373.      E1 or E
  4374.           This switch indicates that the second argument is a DOS
  4375.           environment variable.  If it is not found in the environment, the
  4376.           {COMMO} variable will be set to NULL.
  4377.  
  4378.           Note that environment variable names are CASE SENSITIVE (they are
  4379.           usually upper case).
  4380.  
  4381.      E0
  4382.           Normal variable (default).
  4383.  
  4384.      S1 or S
  4385.           This switch will cause "double expansion" of the second argument
  4386.           (indirect variable).  First {COMMO} will substitute any variables
  4387.           indicated by "%" signs.  The resulting string (which must NOT
  4388.           begin with a "%") will then be treated as a variable name and
  4389.           expanded again.
  4390.  
  4391.           This facility may be used to create a "subscript."
  4392.  
  4393.      S0
  4394.           Single expansion (default).
  4395.  
  4396. Examples:
  4397.  
  4398.      {setv net,nodeid}
  4399.           Assign the string "nodeid" to the variable name "net".
  4400.  
  4401.      {setv nodeid,ggcs_bbs}
  4402.           Assign the string "ggcs_bbs" to the variable name "nodeid".
  4403.  
  4404.      {setv-s bbs,nodeid}
  4405.           Assuming the above examples have been executed, this will set the
  4406.           variable "bbs" to "ggcs_bbs".
  4407.  
  4408.      {setv-s board,%net}
  4409.           Assuming the above examples have been executed, this will set the
  4410.           variable "board" to "ggcs_bbs".
  4411.  
  4412.  
  4413.  
  4414.                                     -82-
  4415.  
  4416.  
  4417.      {setv-s xxx,yyy%index}
  4418.           Suppose the variable "index" has the value "3".  It will be
  4419.           expanded first, then "yyy3" will be expanded and its value
  4420.           assigned to "xxx".
  4421.  
  4422.      {setv-e abc,TABLE}
  4423.           Assuming a "SET TABLE=" DOS command has been executed prior to
  4424.           running {COMMO}, the variable "abc" will be set to the
  4425.           environment string.
  4426.  
  4427.      {setv abc} or {setv abc,}
  4428.           Set the variable "abc" to null (it will be deleted from variable
  4429.           space).
  4430.  
  4431.  
  4432. ===  SFICtrl  ===
  4433.  
  4434. Default key:   none
  4435. Description:   Speech Friendly Interface control.
  4436.  
  4437. Examples:
  4438.  
  4439.      {sfic}
  4440.           Toggle Speech Friendly Interface on/off.
  4441.  
  4442.      {sfic y}
  4443.           Turn on Speech Friendly Interface.
  4444.  
  4445.      {sfic n}
  4446.           Turn off Speech Friendly Interface.
  4447.  
  4448. The built-in variable "_sfi" is 1 when the Speech Friendly Interface is ON,
  4449. 0 when it is OFF.
  4450.  
  4451.  
  4452. ===  SHELl  ===
  4453.  
  4454. Default key:   Alt-S
  4455. Description:   Shell to DOS.
  4456.  
  4457. Switches:
  4458.  
  4459.      S1 or S
  4460.           Swap to disk before shelling to DOS (see details under EXECute,
  4461.           "Using the Swap to Disk Switch").
  4462.  
  4463.      S0
  4464.           Do not swap to disk (default).
  4465.  
  4466.  
  4467.  
  4468.                                     -83-
  4469.  
  4470. Examples:
  4471.  
  4472.      {shell}
  4473.           No arguments.
  4474.  
  4475.      {shell-s}
  4476.           Swap to disk before shelling to DOS.
  4477.  
  4478.  
  4479. ===  SIGNal  ===
  4480.  
  4481. Default key:   none
  4482. Description:   Set state of hardware signals.
  4483.  
  4484. Switches:
  4485.  
  4486.      D1 or D
  4487.           Set DTR high.
  4488.  
  4489.      D0
  4490.           Set DTR low.
  4491.  
  4492.      R1 or R
  4493.           Set RTS high.
  4494.  
  4495.      R0
  4496.           Set RTS low.
  4497.  
  4498. Example:
  4499.  
  4500.      {signal-d0r1}
  4501.           Turn off DTR, turn on RTS.
  4502.  
  4503. The "D" and "R" switches are used to control the RS-232C signals DTR (Data
  4504. Terminal Ready) and RTS (Request To Send).  The default for each switch is
  4505. to leave the signal unchanged.  Use these with care due to interaction with
  4506. Hardware Flow Control, etc.
  4507.  
  4508.  
  4509. ===  SOUNd  ===
  4510.  
  4511. Default key:   none
  4512. Description:   Set Master Sound toggle.
  4513.  
  4514. Examples:
  4515.  
  4516.      {sound}
  4517.           Toggle Master Sound on/off.
  4518.  
  4519.  
  4520.  
  4521.                                     -84-
  4522.  
  4523.      {sound y}
  4524.           Turn on Master Sound.
  4525.  
  4526.      {sound n}
  4527.           Turn off Master Sound.
  4528.  
  4529.  
  4530. ===  SPDCtrl  ===
  4531.  
  4532. Default key:   none
  4533. Description:   Serial port display control.
  4534.  
  4535. Examples:
  4536.  
  4537.      {spdc y}
  4538.           Serial port display is ON.
  4539.  
  4540.      {spdc n}
  4541.           Serial port display is OFF.
  4542.  
  4543. This function will suppress display of any data received from the serial
  4544. port.  It can be used when a "clean" display is desired during automated
  4545. procedures.
  4546.  
  4547. TIPS on using SPDCtrl:
  4548.  
  4549.  *   Serial port display can be suppressed only while a macro is running
  4550.      (it will be restored to ON at macro termination).
  4551.  
  4552.  *   ANSI control sequences are not processed while the display is OFF
  4553.      (Terminal Emulation effectively reverts to TTY).
  4554.  
  4555.  *   LOOKfor will function normally, but remember that ANSI sequences are
  4556.      not stripped.  Make a manual run using TTY emulation to see what the
  4557.      LOOKfor will see.
  4558.  
  4559.  *   SCREEN Capture Mode will not capture any of the incoming data.  If
  4560.      capture is required, RAW mode or FILTER mode must be used (note that
  4561.      ANSI sequences will not be removed).
  4562.  
  4563.  
  4564. ===  SPOCtrl  ===
  4565.  
  4566. Default key:   none
  4567. Description:   Serial port output control.
  4568.  
  4569. Examples:
  4570.  
  4571.      {spoc y}
  4572.           Serial port output is ON.
  4573.  
  4574.      {spoc n}
  4575.           Serial port output is OFF.
  4576.  
  4577.  
  4578.  
  4579.                                     -85-
  4580.  
  4581.  
  4582. This function will inhibit any data from being sent to the serial port. 
  4583. All other program operations will be normal.  It is used for "local mode"
  4584. in host macros (no data is sent to the modem).
  4585.  
  4586. TIPS on using SPOCtrl:
  4587.  
  4588.  *   Serial port output can be inhibited only while a macro is running (it
  4589.      will be restored to ON at macro termination).
  4590.  
  4591.  *   Dialing and internal protocols will not operate properly if serial
  4592.      port output is turned OFF.
  4593.  
  4594.  
  4595. ===  SSLOok  ===
  4596.  
  4597. Default key:   none
  4598. Description:   Send a string when a string appears.
  4599.  
  4600. General form:
  4601.  
  4602.      {SSLOok name,target}
  4603.  
  4604.           name
  4605.                The name of a string variable (MUST be a variable).
  4606.  
  4607.           target
  4608.                The ASCII string to look for.  The string begins following
  4609.                the "," and is terminated by the "}".
  4610.  
  4611. Switches:
  4612.  
  4613.      R or R1
  4614.           Send a carriage return after sending the variable string to the
  4615.           serial port.
  4616.  
  4617.      R0
  4618.           Do not send a carriage return (default).
  4619.  
  4620. Example:
  4621.  
  4622.      {setv ss_r,|} {setv ss_nr,n|}
  4623.      ...
  4624.      {sslo-r _pas,password:}
  4625.      {sslo ss_r,Press enter to continue}
  4626.      {sslo ss_nr,Do you want to log off?}
  4627.      {look command?} ...
  4628.  
  4629. SSLOok is used in conjunction with the LOOKfor function.  It sets up an
  4630. additional string to look for.  When the target string appears, the string
  4631. in the variable is sent to the serial port.  The LOOKfor timeout (specified
  4632. in a SETLook) is restarted and the LOOKfor continues to look for all
  4633. specified strings.
  4634.  
  4635.  
  4636.  
  4637.                                     -86-
  4638.  
  4639.  
  4640. See LOOKfor for details, examples and tips on using SSLOok.
  4641.  
  4642. See also CALOok, GOLOok, SETLook.
  4643.  
  4644.  
  4645. ===  STATusline  ===
  4646.  
  4647. Default key:   none
  4648. Description:   Set Status Line toggle.
  4649.  
  4650. IMPORTANT!  The Status Line is {COMMO}'s instrument panel.  You should not
  4651. turn it off until you are familiar with operating the program.
  4652.  
  4653. Examples:
  4654.  
  4655.      {statusline}
  4656.           Toggle Status Line on/off.
  4657.  
  4658.      {status y}
  4659.           Turn on Status Line.
  4660.  
  4661.      {status n}
  4662.           Turn off Status Line.
  4663.  
  4664. When the Status Line is off (not visible), The Terminal Screen has one
  4665. additional display row (e.g., 25 rows instead of 24).
  4666.  
  4667. The STATusline function is ignored while in Chat Mode.
  4668.  
  4669.  
  4670. ===  STOP  ===
  4671.  
  4672. Default key:   none
  4673. Description:   Halt macro execution.
  4674.  
  4675. Examples:
  4676.  
  4677.      {stop}
  4678.           No arguments.
  4679.  
  4680.      {}
  4681.           Short form.
  4682.  
  4683. STOP always returns {COMMO} to manual operation in the Terminal Screen. 
  4684. All macro parameters are reset (except string variables).  This includes
  4685. the macro push/pop stack, SETLook, SETGet, SETEsc, etc.  Files opened with
  4686. ROPEn and WOPEn will be closed.
  4687.  
  4688.  
  4689.  
  4690.                                     -87-
  4691.  
  4692. ===  STRAn  ===
  4693.  
  4694. Default key:   none
  4695. Description:   Maintain Send Translate Table.
  4696.  
  4697. Switches:
  4698.  
  4699.      I1 or I
  4700.           Initialize Send Translate Table to default values (consecutive 0
  4701.           to 255).
  4702.  
  4703.      I0
  4704.           Do not initialize (default).
  4705.  
  4706. Examples:
  4707.  
  4708.      {stran y}
  4709.           Turn send translation ON.
  4710.  
  4711.      {stran-i n}
  4712.           Initialize the table and turn it OFF.
  4713.  
  4714.      {stran-i y,92,47}
  4715.           Initialize the table, turn send translation ON, change "\" to
  4716.           "/".
  4717.  
  4718.      {stran}
  4719.           Toggle send translation ON/OFF.
  4720.  
  4721.      {stran #13,65,78,#13,78,65,#13,97,110,#13,110,97}
  4722.           ROT13 translation.  This swaps the first 13 letters of the
  4723.           alphabet for the second 13.
  4724.  
  4725. Rules for STRAn arguments are the same as for the {str=} item in the Setup
  4726. File.  In addition, "n" may be used as the first argument to turn send
  4727. translation OFF at any time.
  4728.  
  4729. See "Edit Setup File" in Part I (COMMO.DOC) for details and more examples.
  4730.  
  4731. TIPS on using STRAn:
  4732.  
  4733.  *   Some control characters are unaffected by translation when certain
  4734.      features are enabled.  Examples:  XON (17) and XOFF (19) are not
  4735.      translated when Software Flow Control is on.  When ENQ/ACK emulation
  4736.      is on, an ACK sent in response to an ENQ will not be translated.
  4737.  
  4738.  *   In GETString, data echoed to the modem (and displayed locally) will be
  4739.      translated with the Send Translate Table (it may be necessary to turn
  4740.      send translation off during certain GETString functions).
  4741.  
  4742. See also RTRAn.
  4743.  
  4744.  
  4745.  
  4746.                                     -88-
  4747.  
  4748. ===  SUBString  ===
  4749.  
  4750. Default key:   none
  4751. Description:   Move a substring to a variable.
  4752.  
  4753. General form:
  4754.  
  4755.      {SUBString name,start,count,string}
  4756.  
  4757.           name
  4758.                The name of the variable to which the substring will be
  4759.                assigned.
  4760.  
  4761.           start
  4762.                The starting character number (first character is "1").  If
  4763.                it is negative, {COMMO} will count in from the end of the
  4764.                string.
  4765.  
  4766.                If it is too large and positive, the substring will be null.
  4767.  
  4768.                If it is too large and negative, the substring will start at
  4769.                the beginning of the string.
  4770.  
  4771.           count
  4772.                The number of characters to use.  If the number is too
  4773.                large, {COMMO} will use as many as possible.  If the count
  4774.                is 0, the substring will be null.
  4775.  
  4776.           string
  4777.                The string to use.
  4778.  
  4779. Examples:
  4780.  
  4781.      {subs var_sub,2,4,abcdefgh}
  4782.           Set "var-sub" to "bcde".
  4783.  
  4784.      {subs newvar,-5,20,abcdefgh}
  4785.           Set "newvar" to "defgh".
  4786.  
  4787.  
  4788. ===  SXMOdem  ===
  4789.  
  4790. Default key:   none
  4791. Description:   Send a file using the Xmodem protocol.
  4792.  
  4793. Switches:
  4794.  
  4795.      See SYMOdem (switches are the same).
  4796.  
  4797.  
  4798.  
  4799.                                     -89-
  4800.  
  4801. Example:
  4802.  
  4803.      {sxmo-ka c:\ul\file.zip}
  4804.           Send "file.zip" using 1024 byte block size (Xmodem-1k), sound the
  4805.           alarm.
  4806.  
  4807. Only one file may be sent with each SXMOdem function.
  4808.  
  4809. See SYMOdem for tips that apply to both SXMOdem and SYMOdem.
  4810.  
  4811.  
  4812. ===  SYMOdem  ===
  4813.  
  4814. Default key:   none
  4815. Description:   Send a file using the Ymodem Batch protocol.
  4816.  
  4817. Switches:
  4818.  
  4819.      NOTE: U, D, A and W switches are the same as for SZMOdem.
  4820.  
  4821.      K1 or K
  4822.           Use 1024 byte block size.
  4823.  
  4824.      K0
  4825.           Use 128 byte block size (default).
  4826.  
  4827. Examples:
  4828.  
  4829.      {symo-ka %uldir\*.zip}
  4830.           Send all .ZIP files in the upload directory using 1024 byte block
  4831.           size, sound the alarm.
  4832.  
  4833.      {symo-k c:\subdir\*.*,@c:\ul\file.lst,info.txt,a:*.qw?}
  4834.           Send all files listed using 1024 byte block size.
  4835.  
  4836. See "File Specifications" under SZMOdem for more details on specifying
  4837. files for uploading.
  4838.  
  4839. TIPS on using SYMOdem and SXMOdem:
  4840.  
  4841.  *   CRC vs. Csum mode and use of "G" method is determined by the receiver. 
  4842.      Block size is determined by the sender.  {COMMO} will always use 1024
  4843.      byte blocks with "G" method.
  4844.  
  4845.  *   Some conditions that will cancel a transfer:
  4846.        1)  10 consecutive errors.
  4847.        2)  Any error when "G" method is used.
  4848.        3)  The receiver has transmitted CAN (^X) characters.
  4849.        4)  Loss of carrier.
  4850.  
  4851.  *   The Exit Code (test with IFER) will be set at the end of the transfer
  4852.      and will also be stored in the variable "_err".  0 means all files
  4853.  
  4854.  
  4855.  
  4856.                                     -90-
  4857.  
  4858.      were transferred successfully.  1 means one or more files in the batch
  4859.      were not completed.
  4860.  
  4861.  *   If the Usage Log is enabled, an entry will be made after each file is
  4862.      transferred (or if a transfer is cancelled).
  4863.  
  4864.  
  4865. ===  SZMOdem  ===
  4866.  
  4867. Default key:   none
  4868. Description:   Send a file using the Zmodem Batch protocol.
  4869.  
  4870. Switches:
  4871.  
  4872.      R1 or R
  4873.           Tell the receiving program to resume the transfer at the end of
  4874.           the existing file.
  4875.  
  4876.      U1 or U
  4877.           Delete files after successful transmission.  Use with CAUTION!
  4878.  
  4879.      D1 or D
  4880.           Cancel transfer if carrier detect is lost (default).
  4881.  
  4882.           NOTE:  If carrier detect is off when the transfer is started,
  4883.           this switch will behave as if "D0" had been set.
  4884.  
  4885.      D0
  4886.           Ignore state of carrier detect.
  4887.  
  4888.      A1 or A
  4889.           Sound the alarm at end of transfer.
  4890.  
  4891.      A0
  4892.           Do not sound the alarm (default).
  4893.  
  4894.      W
  4895.           Wait for a keypress at end of transfer.
  4896.  
  4897.      Wn
  4898.           Wait for "n" seconds, "n" may range from 0 to 999.  Press a key
  4899.           to cancel the wait.
  4900.  
  4901.           Note:  Default (no "W" switch) is no wait.
  4902.  
  4903. Examples:
  4904.  
  4905.      {szmo-a %uldir\*.*}
  4906.           Send all files in the upload directory, sound the alarm when
  4907.           finished.
  4908.  
  4909.      {szmo-u ginger.rep}
  4910.           Send "ginger.rep" and delete it after a successful transfer.
  4911.  
  4912.  
  4913.  
  4914.                                     -91-
  4915.  
  4916.  
  4917.  
  4918. ----------  File Specifications
  4919.  
  4920. Any combination of file specifications may be listed in the SZMOdem or
  4921. SYMOdem functions.  These must be separated with commas and may include
  4922. wildcard specifiers (*,?), the indirect file specifier (@) and any single
  4923. files.
  4924.  
  4925. If a filespec is preceded with the "@" sign, it will be assumed to be an
  4926. "indirect file."  This means that it is a text file containing a list of
  4927. filespecs.  Filespecs should be listed one per line and each line should
  4928. end with a cr/lf (i.e., a normal text file).  Each filespec may contain
  4929. wildcards.  For example:
  4930.  
  4931.      c:\subdir\*.*
  4932.      info.txt
  4933.      a:*.qw?
  4934.  
  4935. TIPS on using SZMOdem:
  4936.  
  4937.  *   Some conditions that will cancel a transfer:
  4938.        1)  20 consecutive errors.
  4939.        2)  The receiver has cancelled.
  4940.        3)  Loss of carrier.
  4941.  
  4942.  *   The Exit Code (test with IFER) will be set at the end of the transfer
  4943.      and will also be stored in the variable "_err".  0 means all files
  4944.      were transferred successfully.  1 means one or more files in the batch
  4945.      were not completed.
  4946.  
  4947.  *   If the Usage Log is enabled, an entry will be made after each file is
  4948.      transferred (or if a transfer is cancelled).
  4949.  
  4950.  
  4951. ===  TOGGles  ===
  4952.  
  4953. Default key:   Alt-T
  4954. Description:   Set various toggle parameters.
  4955.  
  4956. Example:
  4957.  
  4958.      {toggles}
  4959.           Open Set Toggles window.
  4960.  
  4961.  
  4962. ===  UNLOad  ===
  4963.  
  4964. Default key:   none
  4965. Description:   Unload the current auxiliary Macro File.
  4966.  
  4967.  
  4968.  
  4969.                                     -92-
  4970.  
  4971. Examples:
  4972.  
  4973.      {unload}
  4974.           No arguments.
  4975.  
  4976. The auxiliary Macro File will be released from memory.  If no auxiliary is
  4977. loaded, no action will be taken.
  4978.  
  4979. If this function is executed from the auxiliary file, a STOP will occur
  4980. after the auxiliary is released.
  4981.  
  4982. See also CALL, GOTO.
  4983.  
  4984.  
  4985. ===  UNMArk  ===
  4986.  
  4987. Default key:   none
  4988. Description:   Unmark Dialing Directory entries.
  4989.  
  4990. Switches:
  4991.  
  4992.      L1 or L
  4993.           Unmark last-dialed entry only.
  4994.  
  4995.      L0
  4996.           Unmark all or listed entries (default).
  4997.  
  4998. Examples:
  4999.  
  5000.      {unmark joes-bbs,file-city}
  5001.           Unmark listed entries.
  5002.  
  5003.      {unmark}
  5004.           Unmark all entries.
  5005.  
  5006.      {unmark-L}
  5007.           Unmark last-dialed entry.
  5008.  
  5009. NOTE:  When the "L" switch is present, any Dialing Strings listed will be
  5010. ignored.
  5011.  
  5012. Dialing Strings may be separated by spaces or commas.
  5013.  
  5014. {COMMO} will search the Dialing Directory for each string and unmark the
  5015. first entry where a match is found.  Case is ignored.
  5016.  
  5017. The strings may consist of any part of a Dialing Directory entry line
  5018. (including strings contained within curly braces), but must NOT contain any
  5019. spaces, commas or curly braces.
  5020.  
  5021. See also DIAL, MARK.
  5022.  
  5023.  
  5024.  
  5025.                                     -93-
  5026.  
  5027. ===  VIDEo  ===
  5028.  
  5029. Default key:   none
  5030. Description:   Change to an alternate hardware video mode.
  5031.  
  5032. Switches:
  5033.  
  5034.      M1 or M
  5035.           Change to the alternate display mode.
  5036.  
  5037.      M0
  5038.           Change back to the normal display mode.
  5039.  
  5040. Examples:
  5041.  
  5042.      {video-m1}
  5043.           Change to the alternate mode.
  5044.  
  5045.      {video-m0}
  5046.           Change back to the normal mode.
  5047.  
  5048. The "alternate" mode is defined by Setup File item {avm=}.  The "normal"
  5049. mode is the mode in effect when you start {COMMO}.
  5050.  
  5051.  
  5052. ===  VTCUr  ===
  5053.  
  5054. Default key:   none
  5055. Description:   Define a VT102 cursor (arrow) key.
  5056.  
  5057. Example:
  5058.  
  5059.      {vtcur ^[[A|^[OA}
  5060.           Define up-arrow key strings.
  5061.  
  5062. The first string is sent when cursor mode is active; the second string is
  5063. sent when application mode is active (these modes are controlled by the
  5064. host).
  5065.  
  5066. The two strings must be separated by a "|".  Use "^m" for carriage return
  5067. if necessary.
  5068.  
  5069. See also VTPAd.
  5070.  
  5071.  
  5072. ===  VTPAd  ===
  5073.  
  5074. Default key:   none
  5075. Description:   Define a VT102 keypad key.
  5076.  
  5077.  
  5078.  
  5079.                                     -94-
  5080.  
  5081. Example:
  5082.  
  5083.      {vtpad 5|^[Ou}
  5084.           Define keypad "5" key strings.
  5085.  
  5086. The first string is sent when numeric mode is active; the second string is
  5087. sent when application mode is active (these modes are controlled by the
  5088. host).
  5089.  
  5090. The two strings must be separated by a "|".  Use "^m" for carriage return
  5091. if necessary.
  5092.  
  5093. See also VTCUr.
  5094.  
  5095.  
  5096. ===  WCLOse  ===
  5097.  
  5098. Default key:   none
  5099. Description:   Close the write file.
  5100.  
  5101. Example:
  5102.  
  5103.      {wclose}
  5104.           No arguments.
  5105.  
  5106. NOTE:  The write file will be closed automatically when the macro
  5107. terminates (STOP, EXIT, etc.).
  5108.  
  5109. See also WOPEn, WRITE.
  5110.  
  5111.  
  5112. ===  WINDow  ===
  5113.  
  5114. Default key:   none
  5115. Description:   Preserve window display.
  5116.  
  5117. Switches:
  5118.  
  5119.      K1 or K
  5120.           Do not allow the Terminal Screen to be restored when exiting from
  5121.           a window.
  5122.  
  5123.      K0
  5124.           Allow the Terminal Screen to be restored when exiting from a
  5125.           window (default).
  5126.  
  5127. Examples:
  5128.  
  5129.      {window-k}
  5130.           Don't restore the Terminal Screen.
  5131.  
  5132.      {wind-k0}
  5133.           Restore the Terminal Screen.
  5134.  
  5135.  
  5136.  
  5137.                                     -95-
  5138.  
  5139.  
  5140. This function will prevent the Terminal Screen from being restored after a
  5141. window function exits.  It is useful for making smooth, flicker-free
  5142. transitions between windows or for placing one pop-up window on top of
  5143. another.
  5144.  
  5145. The condition will remain active until either the "k0" switch is used or
  5146. the macro terminates.
  5147.  
  5148.  
  5149. ===  WOPEn  ===
  5150.  
  5151. Default key:   none
  5152. Description:   Open a file for writing.
  5153.  
  5154. Switches:
  5155.  
  5156.      A1 or A
  5157.           Open the file in "append" mode.  New lines written to the file
  5158.           will be added at the end.  If the file doesn't exist, it will be
  5159.           created.
  5160.  
  5161.      A0
  5162.           Open the file in "create" mode.  If the file exists, it will be
  5163.           erased (default).
  5164.  
  5165. Examples:
  5166.  
  5167.      {wopen c:\bbs\file.txt}
  5168.           Open the file in create mode.
  5169.  
  5170.      {wopen-a c:\data\word.fil}
  5171.           Open the file in append mode.
  5172.  
  5173. TIP on using WOPEn:
  5174.  
  5175.  *   Only one file may be opened for writing (and one for reading).
  5176.  
  5177. See also WRITe, WCLOse.
  5178.  
  5179.  
  5180. ===  WRITe  ===
  5181.  
  5182. Default key:   none
  5183. Description:   Write a string to the write file.
  5184.  
  5185. Examples:
  5186.  
  5187.      {write %nextline}
  5188.           Write the contents of the variable "nextline" to the write file.
  5189.  
  5190.  
  5191.  
  5192.                                     -96-
  5193.  
  5194.      {write}
  5195.           Write a carriage return/linefeed only (blank line) to the file.
  5196.  
  5197.      {write %num%> }
  5198.           Write the contents of "num" followed by a ">" and a space.
  5199.  
  5200. TIPS on using WRITe:
  5201.  
  5202.  *   A file must be open for writing or a Macro Error will result.
  5203.  
  5204.  *   The string will be written as one line, terminated by a carriage
  5205.      return/linefeed.
  5206.  
  5207.  *   Control character conversion is NOT performed on the write string.
  5208.  
  5209.  *   A Macro Error will result if the disk is full.
  5210.  
  5211. See also WOPEn, WCLOse
  5212.  
  5213.  
  5214.  
  5215.                                     -97-
  5216.  
  5217. For APPENDICES see Part I, COMMO.DOC.
  5218.  
  5219.